Skip to main content

Protobuf Reference

Admin API protobuf

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

SourceCanton Admin API protobuf trees from published release bundles
Version filterstable Canton release bundles >= 3.2.0
Latest releasev3.6.1
Packages13
Endpoints131
Messages388

Release Summary

Each release lists the endpoints it added, changed, or removed, with message and enum counts. Endpoint names link to their reference pages and release versions link to the History section. Releases with no API changes: 3.4.7, 3.4.8, 3.4.9, 3.4.10, 3.5.2, 3.5.3, 3.5.5, 3.5.6, 3.5.7, 3.5.8, 3.5.9, 3.5.10, 3.5.11, 3.5.12, 3.5.13, 3.5.14, 3.5.15, 3.5.16, 3.5.17, 3.5.18, 3.5.19.
3.5.4

Messages: 2 added, 2 changed. Enum: 1 added.

3.4.11

Messages: 2 changed. Enum: 1 added.

3.4.6

Enum: 1 changed.

3.4.0
Baseline

First release covered by this reference: 123 endpoints, 366 messages, 10 enums.

Participant Administration

com.digitalasset.canton.admin.participant.v30
gRPCAdded 3.6.1Updated 3.5.1Methods removed in 3.5.1

12 services, 80 endpoints, 186 messages, 8 enums

Services12
Endpoints80
Messages186
Enums8

Sequencer

1 services, 1 endpoints, 13 messages, 1 enums

Services1
Endpoints1
Messages13
Enums1

Mediator

1 services, 1 endpoints, 3 messages

Services1
Endpoints1
Messages3
Enums0

Shared Administration

com.digitalasset.canton.admin.health.v30
gRPCMethods removed in 3.5.1

1 services, 4 endpoints, 9 messages, 1 enums

Services1
Endpoints4
Messages9
Enums1

1 services, 12 endpoints, 34 messages

Services1
Endpoints12
Messages34
Enums0

1 services, 2 endpoints, 4 messages

Services1
Endpoints2
Messages4
Enums0
com.digitalasset.canton.topology.admin.v30
gRPCAdded 3.5.1Methods removed in 3.5.1

4 services, 39 endpoints, 107 messages, 1 enums

Services4
Endpoints39
Messages107
Enums1

Schema Packages

com.digitalasset.canton.admin
gRPCAdded 3.6.1Updated 3.5.1Methods removed in 3.5.1

0 services, 0 endpoints, 0 messages

Services0
Endpoints0
Messages0
Enums0

0 services, 0 endpoints, 1 messages, 1 enums

Services0
Endpoints0
Messages1
Enums1

0 services, 0 endpoints, 28 messages

Services0
Endpoints0
Messages28
Enums0

0 services, 0 endpoints, 2 messages

Services0
Endpoints0
Messages2
Enums0

0 services, 0 endpoints, 1 messages

Services0
Endpoints0
Messages1
Enums0
com.digitalasset.canton.topology.admin
gRPCAdded 3.5.1Methods removed in 3.5.1

0 services, 0 endpoints, 0 messages

Services0
Endpoints0
Messages0
Enums0

History

Added3.6.1

com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/DeletePendingOperation

com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/DeleteSynchronizerConnectionConfig

com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/DigestConsistencyCheckStatus

com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ListPendingOperations

com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ReinitializeDigestCommitments

com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ReinitializeDigestCommitmentsStatus

com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/RunDigestConsistencyCheck

Methods removed in3.5.1

com.digitalasset.canton.admin.health.v30.StatusService/GetLastErrorTrace: Last available in 3.4.11. Retained for historical reference.

com.digitalasset.canton.admin.health.v30.StatusService/GetLastErrors: Last available in 3.4.11. Retained for historical reference.

com.digitalasset.canton.admin.participant.v30.EnterpriseParticipantReplicationService/SetPassive: Last available in 3.4.11. Retained for historical reference.

com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ExportAcsOld: Last available in 3.4.11. Retained for historical reference.

com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/ImportAcsOld: Last available in 3.4.11. Retained for historical reference.

com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSequencerConnectionSuccessor: Last available in 3.4.11. Retained for historical reference.

com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSynchronizerUpgradeAnnouncement: Last available in 3.4.11. Retained for historical reference.

com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/LogicalUpgradeState: Last available in 3.4.11. Retained for historical reference.

Updated3.5.1

com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ConnectSynchronizer: file updated

com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/DisconnectAllSynchronizers: file updated

com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/DisconnectSynchronizer: file updated

com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/GetSynchronizerId: file updated

com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ListConnectedSynchronizers: file updated

com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ListRegisteredSynchronizers: file updated

com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/Logout: file updated

com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ModifySynchronizer: file updated

com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ReconnectSynchronizer: file updated

com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ReconnectSynchronizers: file updated

com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/RegisterSynchronizer: file updated

Added3.5.1

com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/PerformLateLsu

com.digitalasset.canton.admin.participant.v30.ParticipantReplicationService/SetPassive

com.digitalasset.canton.admin.participant.v30.PartyManagementService/AddPartyWithAcsAsync

com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/PerformManualLsu

com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListAllV2

com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListLsuAnnouncement

com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListLsuSequencerConnectionSuccessor

com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/ListSequencingParametersState

com.digitalasset.canton.topology.admin.v30.TopologyManagerReadService/SequencerLsuState