Canton developer docs / Reference

Complete documentation page mirrored and translated for learning. Attribution is shown at the bottom of each article.

阅读中文版

referenceadmin-apiprotobufindex

Details and History

Documentation Index

Fetch the complete documentation index at: https://docs.canton.network/llms.txt Use this file to discover all available pages before exploring further.

Details and History

Descriptor-backed protobuf API history grouped by package.

Protobuf Reference

Details and History

Operation-first gRPC pages with package-level browsing and recursive related schema sections.

Protobuf 
<span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">v3.5.1</span>
Source
Canton Admin API protobuf trees from published release bundles
<div class="x2mdx-ref-meta-item">
  <dt>Version filter</dt>
  <dd>stable Canton release bundles >= 3.2.0</dd>
</div>

<div class="x2mdx-ref-meta-item">
  <dt>Latest release</dt>
  <dd>v3.5.1</dd>
</div>

<div class="x2mdx-ref-meta-item">
  <dt>Packages</dt>
  <dd>11</dd>
</div>

<div class="x2mdx-ref-meta-item">
  <dt>Endpoints</dt>
  <dd>124</dd>
</div>

<div class="x2mdx-ref-meta-item">
  <dt>Messages</dt>
  <dd>368</dd>
</div>

Release Summary

Counts are shown as added / changed / removed within each release slice.

3.4.0

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">Release</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">Endpoint / message / enum deltas for this release.</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Endpoints</dt>
    <dd>123 / 0 / 0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>366 / 0 / 0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>10 / 0 / 0</dd>
  </div>
</dl>

3.4.2

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">Release</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">Endpoint / message / enum deltas for this release.</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Endpoints</dt>
    <dd>0 / 0 / 0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>0 / 0 / 0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>0 / 0 / 0</dd>
  </div>
</dl>

3.4.3

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">Release</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">Endpoint / message / enum deltas for this release.</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Endpoints</dt>
    <dd>0 / 0 / 0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>0 / 0 / 0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>0 / 0 / 0</dd>
  </div>
</dl>

3.4.4

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">Release</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">Endpoint / message / enum deltas for this release.</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Endpoints</dt>
    <dd>0 / 0 / 0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>0 / 0 / 0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>0 / 1 / 0</dd>
  </div>
</dl>

3.4.5

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">Release</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">Endpoint / message / enum deltas for this release.</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Endpoints</dt>
    <dd>0 / 0 / 0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>0 / 0 / 0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>0 / 0 / 0</dd>
  </div>
</dl>

3.4.6

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">Release</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">Endpoint / message / enum deltas for this release.</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Endpoints</dt>
    <dd>0 / 0 / 0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>0 / 0 / 0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>0 / 0 / 0</dd>
  </div>
</dl>

3.4.7

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">Release</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">Endpoint / message / enum deltas for this release.</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Endpoints</dt>
    <dd>0 / 0 / 0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>0 / 0 / 0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>0 / 0 / 0</dd>
  </div>
</dl>

3.4.8

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">Release</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">Endpoint / message / enum deltas for this release.</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Endpoints</dt>
    <dd>0 / 0 / 0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>0 / 0 / 0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>0 / 0 / 0</dd>
  </div>
</dl>

3.4.9

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">Release</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">Endpoint / message / enum deltas for this release.</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Endpoints</dt>
    <dd>0 / 0 / 0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>0 / 0 / 0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>0 / 0 / 0</dd>
  </div>
</dl>

3.4.10

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">Release</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">Endpoint / message / enum deltas for this release.</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Endpoints</dt>
    <dd>0 / 0 / 0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>0 / 0 / 0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>0 / 0 / 0</dd>
  </div>
</dl>

3.4.11

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">Release</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">Endpoint / message / enum deltas for this release.</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Endpoints</dt>
    <dd>0 / 0 / 0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>0 / 2 / 0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>1 / 0 / 0</dd>
  </div>
</dl>

3.5.1

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">Release</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">Endpoint / message / enum deltas for this release.</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Endpoints</dt>
    <dd>9 / 11 / 8</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>30 / 34 / 28</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>0 / 2 / 0</dd>
  </div>
</dl>

Participant Administration

com.digitalasset.canton.admin.participant.v30

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">11 services, 70 endpoints, 171 messages, 7 enums</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Services</dt>
    <dd>11</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Endpoints</dt>
    <dd>70</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>171</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>7</dd>
  </div>
</dl>

Sequencer

com.digitalasset.canton.admin.sequencer.v30

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">1 services, 1 endpoints, 12 messages, 1 enums</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Services</dt>
    <dd>1</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Endpoints</dt>
    <dd>1</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>12</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>1</dd>
  </div>
</dl>

Mediator

com.digitalasset.canton.admin.mediator.v30

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">1 services, 1 endpoints, 3 messages</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Services</dt>
    <dd>1</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Endpoints</dt>
    <dd>1</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>3</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>0</dd>
  </div>
</dl>

Shared Administration

com.digitalasset.canton.admin.health.v30

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">1 services, 2 endpoints, 9 messages, 1 enums</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Services</dt>
    <dd>1</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Endpoints</dt>
    <dd>2</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>9</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>1</dd>
  </div>
</dl>

com.digitalasset.canton.crypto.admin.v30

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">1 services, 12 endpoints, 33 messages</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Services</dt>
    <dd>1</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Endpoints</dt>
    <dd>12</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>33</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>0</dd>
  </div>
</dl>

com.digitalasset.canton.time.admin.v30

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">1 services, 2 endpoints, 4 messages</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Services</dt>
    <dd>1</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Endpoints</dt>
    <dd>2</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>4</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>0</dd>
  </div>
</dl>

com.digitalasset.canton.topology.admin.v30

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">4 services, 36 endpoints, 105 messages, 1 enums</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Services</dt>
    <dd>4</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Endpoints</dt>
    <dd>36</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>105</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>1</dd>
  </div>
</dl>

Schema Packages

com.digitalasset.canton.admin

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">0 services, 0 endpoints, 0 messages</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Services</dt>
    <dd>0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Endpoints</dt>
    <dd>0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>0</dd>
  </div>
</dl>

com.digitalasset.canton.admin.crypto.v30

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">0 services, 0 endpoints, 1 messages, 1 enums</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Services</dt>
    <dd>0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Endpoints</dt>
    <dd>0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>1</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>1</dd>
  </div>
</dl>

com.digitalasset.canton.admin.pruning.v30

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">0 services, 0 endpoints, 28 messages</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Services</dt>
    <dd>0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Endpoints</dt>
    <dd>0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>28</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>0</dd>
  </div>
</dl>

com.digitalasset.canton.admin.time.v30

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">0 services, 0 endpoints, 2 messages</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Services</dt>
    <dd>0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Endpoints</dt>
    <dd>0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>2</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>0</dd>
  </div>
</dl>

Mirrored from Canton Network official documentation (CC-BY-4.0) by CC Privacy Club for learning purposes.