Reference documentation for the Canton Admin API used for node administration
The Admin API provides administrative access to Canton participant, sequencer, and mediator nodes. It is used for node configuration, topology management, key management, and operational tasks that are not exposed through the Ledger API.
Never expose the Admin API to the public internet. Restrict access to VPN or private networks only. The Admin API provides full administrative control over the node.
The Admin API uses gRPC and is available on the participant’s Admin API port (default: 5002). It is also accessible through the Canton Console, which wraps Admin API calls in a Scala REPL.
Repair operations can cause data inconsistencies if used incorrectly. Only use them when instructed by operational documentation or Canton Network support.
The Canton Console provides a more ergonomic interface to Admin API operations. See Essential Commands for commonly used console commands.
// Example: list connected synchronizers via Canton Consoleparticipant.synchronizers.list_connected// Example: upload a DAR packageparticipant.participant1.dars.upload("dars/CantonExamples.dar")// Example: check node healthparticipant.health.status
