API Reference
REST API reference for the CatalyX Blockchain Manager Canton Console v1.11, covering all 128 endpoints across validators, participants, domains, and more.
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Zero-based offset of the first result to return.
Filter by validator lifecycle phase.
Maximum number of results to return.
Substring matched against the validator name.
OK
Paginated list of ValidatorResponseDto entries plus the total count of validators matching the filter.
Bad Request
Unauthorized
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Splice validator definition: cluster and participant configuration, container image, auth and database settings used to provision a new validator deployment and convert it to the underlying CRD.
Created
Full validator details returned by GET / list endpoints: cluster and participant configuration, app info for validator / wallet / CNS, contact point and optional Keycloak credentials created on first provisioning.
Validator payload is invalid or references unknown resources.
Unauthorized
A validator with the same name already exists.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Partial update payload for a Splice validator. Non-null fields replace the corresponding section of the existing validator; null fields are left unchanged. Includes a cleanRestoreData flag and toggles for ledger-API exposure.
OK
No content
The validator edit payload is invalid or attempts to change immutable fields.
Unauthorized
No validator exists with the name referenced in the payload.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the validator.
OK
The supplied validator name is invalid.
Unauthorized
No validator exists with the given name.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the validator.
Created
No content
The pruning schedule payload is invalid.
Unauthorized
No validator exists with the given name.
A pruning schedule already exists for this validator.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the validator.
No Content
No content
The pruning schedule payload is invalid.
Unauthorized
The validator does not exist or has no pruning schedule configured.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the validator.
No Content
No content
The supplied validator name is invalid.
Unauthorized
No validator exists with the given name.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the validator.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Request body to trigger or schedule a Splice validator backup: cron expression and retention limit.
Created
Persisted backup schedule for a Splice validator: cron expression, retention limit and next-run timestamp.
The backup schedule payload is invalid or the validator uses an external database.
Unauthorized
No validator exists with the given name.
Internal Server Error
Validator database is not running so a backup cannot be scheduled.
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the validator.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Persisted backup schedule for a Splice validator: cron expression, retention limit and next-run timestamp.
The supplied validator name is invalid.
Unauthorized
No validator or backup schedule exists for the given name.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the validator.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Request body to trigger or schedule a Splice validator backup: cron expression and retention limit.
OK
Persisted backup schedule for a Splice validator: cron expression, retention limit and next-run timestamp.
The backup schedule payload is invalid.
Unauthorized
No backup schedule exists for the given validator.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the validator.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*No Content
No content
The supplied validator name is invalid.
Unauthorized
No backup schedule exists for the given validator.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
If set, only return participants whose last known health check matches this value.
Zero-based index of the first registration to return.
Lifecycle phase to filter by (e.g. RUNNING, FAILED).
Maximum number of registrations to return.
Case-sensitive substring matched against the registration name.
OK
Paginated list of RemoteParticipantDto entries plus the total count.
Pagination or filter parameters are invalid.
Unauthorized
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Externally-hosted Canton participant registered in CBM: admin / ledger / JSON-API endpoints, auth provider and identifying metadata.
Created
Externally-hosted Canton participant registered in CBM: admin / ledger / JSON-API endpoints, auth provider and identifying metadata.
The request payload failed validation.
Unauthorized
A remote participant with the same name is already registered in CBM.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Externally-hosted Canton participant registered in CBM: admin / ledger / JSON-API endpoints, auth provider and identifying metadata.
OK
No content
The request payload failed validation.
Unauthorized
No remote participant is registered under the given name.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
CBM-side registration name of the remote participant.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Alias of the domain connection already registered on the participant.
true to connect, false to disconnect
No Content
No content
The participant name or domain alias is invalid.
Unauthorized
Either the participant is not registered in CBM or the domain alias is unknown on the remote node.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
If set, returns only remote domains whose last observed health matches this value.
Zero-based offset of the first remote domain to return.
Lifecycle phase to filter by (e.g. running, failed).
Maximum number of remote domains to return.
Case-insensitive substring filter on the remote domain registration name.
OK
Paginated list of RemoteDomainDto entries plus the total count.
One of the query parameters has an invalid value.
Unauthorized
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Externally-hosted sync domain registered in CBM: admin / public endpoints, image metadata and lifecycle phase.
Created
Externally-hosted sync domain registered in CBM: admin / public endpoints, image metadata and lifecycle phase.
Invalid registration payload.
Unauthorized
A node with the same name is already registered or running in the cluster.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Externally-hosted sync domain registered in CBM: admin / public endpoints, image metadata and lifecycle phase.
OK
No content
Invalid update payload.
Unauthorized
No remote domain is registered under the given name.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
If true, returns only participants reported as healthy; if false, only unhealthy ones.
Zero-based offset of the first participant to return.
Lifecycle phase to filter by (e.g. RUNNING, PENDING, FAILED).
Maximum number of participants to return.
Substring match on the participant Kubernetes resource name.
Storage backend to filter by (e.g. POSTGRES, EXTERNAL, MEMORY).
OK
Paginated list of ParticipantDto entries plus the total count of participants matching the filter.
One or more query parameters failed validation.
Unauthorized
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Canton participant definition: container image, admin / ledger endpoints, authentication, postgres storage and Canton-specific settings used to provision a new participant deployment.
Whether the canton image is enterprise or not
Created
Canton participant definition: container image, admin / ledger endpoints, authentication, postgres storage and Canton-specific settings used to provision a new participant deployment.
Whether the canton image is enterprise or not
The participant payload failed validation.
Unauthorized
A participant or backing workload with the same name already exists.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Canton participant definition: container image, admin / ledger endpoints, authentication, postgres storage and Canton-specific settings used to provision a new participant deployment.
Whether the canton image is enterprise or not
OK
No content
The participant payload failed validation.
Unauthorized
No participant with the given name exists.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the participant holding the connection.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Alias of the previously registered sync domain to (dis)connect.
true to connect, false to disconnect
Admin gRPC port on which to contact the participant.
5019No Content
No content
The participant name, domain alias or port failed validation.
Unauthorized
No such participant exists or the domain alias is not registered.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Name of the Canton node whose log level should be updated
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*New log level to apply
OK
No content
Invalid node name or log level
Unauthorized
Node or its pod not found
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the validator.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Persisted identity-dump schedule for a Splice validator: cron expression, retention limit and next-run timestamp.
Bad Request
Unauthorized
No validator or identity dump schedule exists for the given name.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the validator.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Request body to schedule recurring identity dumps for a Splice validator (cron expression plus retention limit); converts to the underlying CRD.
Created
Persisted identity-dump schedule for a Splice validator: cron expression, retention limit and next-run timestamp.
The schedule payload is invalid.
Unauthorized
No validator exists with the given name.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the validator.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Request body to schedule recurring identity dumps for a Splice validator (cron expression plus retention limit); converts to the underlying CRD.
OK
Persisted identity-dump schedule for a Splice validator: cron expression, retention limit and next-run timestamp.
The schedule payload is invalid.
Unauthorized
No identity dump schedule exists for the given validator.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the validator.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*No Content
No content
The supplied validator name is invalid.
Unauthorized
No identity dump schedule exists for the given validator.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Filter by health status; true returns only healthy domains, false only unhealthy.
Zero-based index of the first domain to return for pagination.
Filter by the lifecycle phase of the domain.
Maximum number of domains to return.
Filter by domain name (substring match).
Filter by the configured storage type of the domain.
OK
Paginated list of DomainDto entries plus the total count of sync domains matching the filter.
One or more query parameters are invalid.
Unauthorized
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Canton sync domain definition: name, container image, log level, admin / public endpoints and Canton-specific bootstrap settings used to provision a single-replica sync domain.
Whether the canton image is enterprise or not
Created
Canton sync domain definition: name, container image, log level, admin / public endpoints and Canton-specific bootstrap settings used to provision a single-replica sync domain.
Whether the canton image is enterprise or not
The request payload is invalid or fails validation.
Unauthorized
A domain with the same name already exists.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Canton sync domain definition: name, container image, log level, admin / public endpoints and Canton-specific bootstrap settings used to provision a single-replica sync domain.
Whether the canton image is enterprise or not
OK
No content
The request payload is invalid or fails validation.
Unauthorized
No sync domain exists with the given name.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Zero-based index of the first HA domain to return for pagination.
Maximum number of HA domains to return.
Filter by HA domain name (substring match).
Filter by the lifecycle phase of the HA domain.
OK
Paginated list of HA sync domain entries plus the total count.
One or more query parameters are invalid.
Unauthorized
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
High-availability sync domain definition: per-component (sequencer, mediator, topology manager) specifications plus in-cluster or external storage settings.
Created
High-availability sync domain definition: per-component (sequencer, mediator, topology manager) specifications plus in-cluster or external storage settings.
The request payload is invalid or fails validation.
Unauthorized
A HA sync domain with the same name already exists.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Partial update payload for an HA sync domain; non-null sections replace the corresponding configuration on the existing deployment.
OK
High-availability sync domain definition: per-component (sequencer, mediator, topology manager) specifications plus in-cluster or external storage settings.
The request payload is invalid or fails validation.
Unauthorized
No HA sync domain exists with the given name.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Zero-based index of the first application to return
Filter by current lifecycle phase of the application
Maximum number of applications to return
Filter by application name (substring match)
Filter by application type
OK
Paginated list of ApplicationDto entries plus the total count of applications matching the filter.
Invalid filter or pagination parameters
Unauthorized
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Generic CBM-deployed application: name, container image, port, package, parent validator and Kubernetes resource requirements; used both as a request and a response body on the applications endpoints.
Created
Generic CBM-deployed application: name, container image, port, package, parent validator and Kubernetes resource requirements; used both as a request and a response body on the applications endpoints.
Invalid application payload
Unauthorized
An application or resource with the same name already exists
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Generic CBM-deployed application: name, container image, port, package, parent validator and Kubernetes resource requirements; used both as a request and a response body on the applications endpoints.
OK
No content
Invalid application payload
Unauthorized
Application not found
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the validator.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Single entry in the validator restore history: filenames restored from, overall status and capture timestamp.
The supplied validator name is invalid.
Unauthorized
No restore job exists for the given validator.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the validator to restore.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Request body to start a Splice validator restore from one or more previously captured backup files.
Created
Single entry in the validator restore history: filenames restored from, overall status and capture timestamp.
The restore payload references missing or invalid backup files.
Unauthorized
No validator exists with the given name.
A restore job is already running for this validator.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Request body for the Splice prefill quorum check; references the sponsor scan address used during validator on-boarding.
OK
Bad Request
Unauthorized
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
CBM-side registration name of the remote participant.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Persisted pruning schedule for a Canton workload: cron expression, retention window, max duration and next-run timestamp.
The supplied participant name is invalid.
Unauthorized
No remote participant is registered under the given name or no schedule is configured.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
CBM-side registration name of the remote participant.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Persisted pruning schedule for a Canton workload: cron expression, retention window, max duration and next-run timestamp.
Created
No content
The participant name, cron expression, or retention payload is invalid.
Unauthorized
No remote participant is registered under the given name.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
CBM-side registration name of the remote participant.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*No Content
No content
The supplied participant name is invalid.
Unauthorized
No remote participant is registered under the given name.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
CBM-side registration name of the remote participant.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Bad Request
Unauthorized
No remote participant is registered under the given name.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
CBM-side registration name of the remote participant.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Bad Request
Unauthorized
No remote participant is registered under the given name.
The remote JSON Ledger API rejected the request due to a state conflict (e.g. duplicate command id).
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
CBM-side registration name of the remote participant.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Bad Request
Unauthorized
No remote participant is registered under the given name.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
CBM-side registration name of the remote participant.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Reference to a DAR package uploaded to a Canton participant: identifying hash, package name and version.
The supplied participant name is invalid.
Unauthorized
No remote participant is registered under the given name.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
CBM-side registration name of the remote participant.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Names of DAR files (already stored in CBM file storage) to upload to the participant.
OK
No content
The participant name or the supplied list of DAR names is invalid.
Unauthorized
The participant is not registered in CBM or a referenced DAR is missing from CBM file storage.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
CBM-side registration name of the remote participant.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Hash of the DAR to remove, as reported by the participant.
OK
No content
The participant name or DAR hash is invalid.
Unauthorized
Either the participant is not registered in CBM or the DAR hash is unknown on the remote node.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
CBM-side registration name of the remote participant.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
The DTO representing a connection to a domain.
It represents the connection status. It is true when the connection is established, false otherwise.
It represents a custom domain. When it is true the domainUrl should be used, use domainName and port otherwise
This is the alias of the domain to connect to. It does not have to be the same as the actual domain name.
This is name of the domain to connect to.
Defines whether the domain name belongs to the HA Domain entity
This is the URL of the domain to connect to. It must be accessible from the participant node. Usage: https://..svc.cluster.local:
This is public port of the domain to connect to.
The supplied participant name is invalid.
Unauthorized
No remote participant is registered under the given name.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
CBM-side registration name of the remote participant.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*The DTO representing a connection to a domain.
It represents the connection status. It is true when the connection is established, false otherwise.
It represents a custom domain. When it is true the domainUrl should be used, use domainName and port otherwise
This is the alias of the domain to connect to. It does not have to be the same as the actual domain name.
This is name of the domain to connect to.
Defines whether the domain name belongs to the HA Domain entity
This is the URL of the domain to connect to. It must be accessible from the participant node. Usage: https://..svc.cluster.local:
This is public port of the domain to connect to.
Created
No content
The connection payload or participant name is invalid.
Unauthorized
No remote participant is registered under the given name.
A domain connection with the same alias is already registered on the remote participant.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
CBM-side registration name of the target remote domain.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Remote domain component to inspect (mediator or sequencer).
OK
Persisted pruning schedule for a Canton workload: cron expression, retention window, max duration and next-run timestamp.
Invalid component value.
Unauthorized
No remote domain is registered under the given name, or no schedule is configured.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
CBM-side registration name of the target remote domain.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Remote domain component the schedule applies to (mediator or sequencer).
Persisted pruning schedule for a Canton workload: cron expression, retention window, max duration and next-run timestamp.
Created
No content
Invalid cron expression, component, or schedule payload.
Unauthorized
No remote domain is registered under the given name.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
CBM-side registration name of the target remote domain.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Remote domain component whose schedule should be cleared (mediator or sequencer).
No Content
No content
Invalid component value.
Unauthorized
No remote domain is registered under the given name, or no schedule exists to clear.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the participant whose restore job to fetch.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Request body to start a participant or domain restore from a previously captured backup file.
The participant name failed validation.
Unauthorized
No restore job exists for the given participant.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the participant to restore.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Request body to start a participant or domain restore from a previously captured backup file.
Created
Request body to start a participant or domain restore from a previously captured backup file.
The body, participant name, or backup file failed validation.
Unauthorized
No participant with the given name exists or the referenced backup file is missing.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the participant whose restore job should be removed.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*No Content
No content
The participant name failed validation.
Unauthorized
No restore job exists for the given participant.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the participant whose pruning schedule to fetch.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Admin gRPC port on which to contact the participant.
5019OK
Persisted pruning schedule for a Canton workload: cron expression, retention window, max duration and next-run timestamp.
The participant name or port failed validation.
Unauthorized
No participant with the given name exists.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the enterprise participant to schedule pruning on.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Admin gRPC port on which to contact the participant.
5019Persisted pruning schedule for a Canton workload: cron expression, retention window, max duration and next-run timestamp.
Created
No content
The body, cron expression, or participant is non-enterprise.
Unauthorized
No participant with the given name exists.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the participant whose pruning schedule to clear.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Admin gRPC port on which to contact the participant.
5019No Content
No content
The participant name or port failed validation.
Unauthorized
No participant with the given name exists.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the participant whose local parties to refresh.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Bad Request
Unauthorized
No participant with the given name exists.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the participant to proxy the call to.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Bad Request
Unauthorized
No participant with the given name exists.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the participant to proxy the call to.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Bad Request
Unauthorized
No participant with the given name exists.
The participant rejected the request as conflicting (for example party already exists).
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the participant to proxy the call to.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Bad Request
Unauthorized
No participant with the given name exists.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the participant to proxy the call to.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Bad Request
Unauthorized
No participant with the given name exists.
The participant rejected the request as conflicting.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the target participant.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Reference to a DAR package uploaded to a Canton participant: identifying hash, package name and version.
The participant name failed validation.
Unauthorized
No participant with the given name exists.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the target participant.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Names of DAR files in the CBM file store to upload (1 to 15 entries).
OK
No content
Validation failed (participant name, DAR list size, or unknown DAR).
Unauthorized
No participant with the given name exists.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the target participant.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Content hash of the DAR to remove, as reported by the list endpoint.
OK
No content
The participant name or DAR hash failed validation.
Unauthorized
No participant with the given name exists or the DAR is not registered.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the participant whose connections to list.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Admin gRPC port on which to contact the participant.
5019OK
The DTO representing a connection to a domain.
It represents the connection status. It is true when the connection is established, false otherwise.
It represents a custom domain. When it is true the domainUrl should be used, use domainName and port otherwise
This is the alias of the domain to connect to. It does not have to be the same as the actual domain name.
This is name of the domain to connect to.
Defines whether the domain name belongs to the HA Domain entity
This is the URL of the domain to connect to. It must be accessible from the participant node. Usage: https://..svc.cluster.local:
This is public port of the domain to connect to.
The participant name or port failed validation.
Unauthorized
No participant with the given name exists.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the participant on which to register the connection.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Admin gRPC port on which to contact the participant.
5019The DTO representing a connection to a domain.
It represents the connection status. It is true when the connection is established, false otherwise.
It represents a custom domain. When it is true the domainUrl should be used, use domainName and port otherwise
This is the alias of the domain to connect to. It does not have to be the same as the actual domain name.
This is name of the domain to connect to.
Defines whether the domain name belongs to the HA Domain entity
This is the URL of the domain to connect to. It must be accessible from the participant node. Usage: https://..svc.cluster.local:
This is public port of the domain to connect to.
Created
No content
The connection payload or participant name failed validation.
Unauthorized
No participant with the given name exists.
The participant is already connected to another incompatible domain.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the participant whose schedule to fetch.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Persisted backup schedule for a Canton workload: cron expression, retention limit and the resolved next-run timestamp.
The participant name failed validation.
Unauthorized
No backup schedule exists for the given participant.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the participant to back up.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Schedule definition used to configure a recurring backup job on a Canton workload (participant or domain). Carries the cron expression that drives the schedule and the maximum number of backups to retain.
Created
Persisted backup schedule for a Canton workload: cron expression, retention limit and the resolved next-run timestamp.
The body, cron expression, or participant name failed validation.
Unauthorized
No participant with the given name exists.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the participant whose schedule should be removed.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*No Content
No content
The participant name failed validation.
Unauthorized
No backup schedule exists for the given participant.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the validator.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Identity-dump artifact metadata: name of the Kubernetes secret holding the dump, the owning validator name and the timestamp at which it was captured.
Bad Request
Unauthorized
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the validator.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Identity-dump artifact metadata: name of the Kubernetes secret holding the dump, the owning validator name and the timestamp at which it was captured.
The supplied validator name is invalid.
Unauthorized
No validator exists with the given name.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Generic HTTP proxy request: target URL, method, custom headers and body forwarded by the proxy controller.
OK
Bad Request
Unauthorized
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Name of the validator whose wallet credentials should be used
Wrapper around a single password value; used by endpoints that update credentials in isolation.
OK
Token response returned by the OAuth2 login flow (access token).
Bad Request
Unauthorized
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Filter by file type/category
Zero-based index of the first file to return
Maximum number of files to return
Filter by file name (substring match)
OK
Paginated list of FileDto entries plus the total count of stored files matching the filter.
Invalid filter or pagination parameters
Unauthorized
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Type/category of the uploaded files (controls allowed extension and storage location)
Multipart files to upload
Created
No content
Invalid file or extension does not match the declared file type
Unauthorized
A file with the same name already exists
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the sync domain whose restore job should be returned.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Request body to start a participant or domain restore from a previously captured backup file.
The supplied domain name is invalid or backup is not supported.
Unauthorized
No restore job exists for the given domain.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the sync domain to restore into.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Request body to start a participant or domain restore from a previously captured backup file.
Created
Request body to start a participant or domain restore from a previously captured backup file.
The request payload is invalid or backup is not supported.
Unauthorized
The sync domain or referenced backup file does not exist.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the sync domain whose restore job should be removed.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*No Content
No content
The supplied domain name is invalid.
Unauthorized
No restore job exists for the given domain.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the sync domain whose schedule should be returned.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Admin gRPC port of the domain to call; defaults to the standard admin port.
5019Domain component to read the pruning schedule from; either MEDIATOR or SEQUENCER.
OK
Persisted pruning schedule for a Canton workload: cron expression, retention window, max duration and next-run timestamp.
The supplied domain name or component is invalid.
Unauthorized
No sync domain exists with the given name.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the sync domain to prune.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Admin gRPC port of the domain to call; defaults to the standard admin port.
5019Domain component to prune; either MEDIATOR or SEQUENCER.
Persisted pruning schedule for a Canton workload: cron expression, retention window, max duration and next-run timestamp.
Created
No content
The cron expression, payload or component is invalid, or the domain is not enterprise.
Unauthorized
No sync domain exists with the given name.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the sync domain whose schedule should be cleared.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Admin gRPC port of the domain to call; defaults to the standard admin port.
5019Domain component to clear the pruning schedule from; either MEDIATOR or SEQUENCER.
No Content
No content
The supplied domain name or component is invalid.
Unauthorized
No sync domain exists with the given name.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the sync domain whose schedule should be returned.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Persisted backup schedule for a Canton workload: cron expression, retention limit and the resolved next-run timestamp.
The supplied domain name is invalid or backup is not supported.
Unauthorized
No backup schedule exists for the given domain.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the sync domain to back up.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Schedule definition used to configure a recurring backup job on a Canton workload (participant or domain). Carries the cron expression that drives the schedule and the maximum number of backups to retain.
Created
Persisted backup schedule for a Canton workload: cron expression, retention limit and the resolved next-run timestamp.
The cron expression or payload is invalid, or backup is not supported.
Unauthorized
No sync domain exists with the given name.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the sync domain whose schedule should be removed.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*No Content
No content
The supplied domain name is invalid.
Unauthorized
No backup schedule exists for the given domain.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Name of the Canton node (participant or domain) to execute the command against
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Canton console script to be executed as a one-shot command against a participant or domain.
No Content
No content
Invalid node name or command payload
Unauthorized
Target node not found
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the validator.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Full validator details returned by GET / list endpoints: cluster and participant configuration, app info for validator / wallet / CNS, contact point and optional Keycloak credentials created on first provisioning.
The supplied validator name is invalid.
Unauthorized
No validator exists with the given name.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the validator.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Whether to also remove related secrets, identity dumps and Keycloak resources.
trueNo Content
No content
The supplied validator name is invalid.
Unauthorized
No validator exists with the given name.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the validator.
OK
Validator backup history: ordered list of previously captured backups with their files and statuses.
The supplied validator name is invalid.
Unauthorized
No validator or backup schedule exists for the given name.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
OK
Splice network endpoints split by environment: devnet, testnet and mainnet.
Bad Request
Unauthorized
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
OK
Bad Request
Unauthorized
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
CBM-side registration name of the remote participant.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Externally-hosted Canton participant registered in CBM: admin / ledger / JSON-API endpoints, auth provider and identifying metadata.
The supplied name does not satisfy node-name constraints.
Unauthorized
No remote participant is registered under the given name.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
CBM-side registration name of the remote participant.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*No Content
No content
The supplied name does not satisfy node-name constraints.
Unauthorized
No remote participant is registered under the given name.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
CBM-side registration name of the remote participant.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Runtime status of a Canton participant: active flag, id, uptime and the lists of currently connected and unhealthy sync domains.
The supplied name does not satisfy node-name constraints.
Unauthorized
No remote participant is registered under the given name.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
CBM-side registration name of the remote domain.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Externally-hosted sync domain registered in CBM: admin / public endpoints, image metadata and lifecycle phase.
The supplied name is not a valid node identifier.
Unauthorized
No remote domain is registered under the given name.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
CBM-side registration name of the remote domain.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*No Content
No content
The supplied name is not a valid node identifier.
Unauthorized
No remote domain is registered under the given name.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
CBM-side registration name of the remote domain to probe.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Runtime status of a single-replica sync domain: active flag, id, uptime, sequencer state and the list of currently connected participants.
The supplied name is not a valid node identifier.
Unauthorized
No remote domain is registered under the given name.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the participant to fetch.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Canton participant definition: container image, admin / ledger endpoints, authentication, postgres storage and Canton-specific settings used to provision a new participant deployment.
Whether the canton image is enterprise or not
The participant name failed validation.
Unauthorized
No participant with the given name exists.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the participant to delete.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*No Content
No content
The participant name failed validation.
Unauthorized
No participant with the given name exists.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the participant to query.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Admin gRPC port on which to contact the participant.
5019OK
Runtime status of a Canton participant: active flag, id, uptime and the lists of currently connected and unhealthy sync domains.
The participant name or port failed validation.
Unauthorized
No participant with the given name exists.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the participant whose available backup files to list.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Entry in the backup history of a Canton workload describing a single backup artifact: file name, size in bytes, status of the backup operation and the timestamp at which it was produced.
File size in bytes
The participant name failed validation.
Unauthorized
No participant with the given name exists.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the participant whose restore history to fetch.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Single entry in a restore history: filename, status, timestamp and any log captured during the restore.
The participant name failed validation.
Unauthorized
No participant with the given name exists.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the participant whose local parties to list.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Bad Request
Unauthorized
No participant with the given name exists.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the participant whose backup history to fetch.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Entry in the backup history of a Canton workload describing a single backup artifact: file name, size in bytes, status of the backup operation and the timestamp at which it was produced.
File size in bytes
The participant name failed validation.
Unauthorized
No participant with the given name exists.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
OK
Connection metadata describing the Canton / Splice cluster CBM is attached to (URL of the cluster control plane).
Unauthorized
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Name of the Canton node whose logs should be returned
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Reference timestamp (ISO-8601) used as the anchor of the log window
If true, fetch lines older than the reference timestamp; otherwise newer
Number of log lines to return (between 20 and 100)
Minimum log level to include
Free-text substring filter applied to log messages
OK
Single Canton-formatted log line: parsed timestamp, log level and message content.
Invalid node name or query parameters
Unauthorized
Node or its pod not found
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Name of the Canton node whose logs should be downloaded
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Number of most recent log lines to include (100-100000, default 10000)
10000If true, fetch logs from the previous (terminated) container instance
falseInvalid node name or query parameters
Unauthorized
Node, pod or previous container instance not found
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
OK
Identity-dump artifact metadata: name of the Kubernetes secret holding the dump, the owning validator name and the timestamp at which it was captured.
Bad Request
Unauthorized
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Name of the Canton node whose health dump files should be listed
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Invalid node name
Unauthorized
Node not found
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Name of the Canton node to generate a health dump for
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Invalid node name
Unauthorized
Node not found
Internal server error while creating or writing health dump file
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Name of the Canton node that owns the health dump file
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Path of the health dump file on the node to download
OK
Invalid node name or file path
Unauthorized
Node or health dump file not found
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Name of the file to download
Type/category of the file to download
OK
Invalid file name or type
Unauthorized
File not found in storage
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Name of the file to delete
Type/category of the file to delete
No Content
No content
Invalid file name or type
Unauthorized
File not found in storage
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the sync domain.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Canton sync domain definition: name, container image, log level, admin / public endpoints and Canton-specific bootstrap settings used to provision a single-replica sync domain.
Whether the canton image is enterprise or not
The supplied domain name is invalid.
Unauthorized
No sync domain exists with the given name.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the sync domain to delete.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*No Content
No content
The supplied domain name is invalid.
Unauthorized
No sync domain exists with the given name.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the sync domain.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Admin gRPC port of the domain to query; defaults to the standard admin port.
5019OK
Runtime status of a single-replica sync domain: active flag, id, uptime, sequencer state and the list of currently connected participants.
The supplied domain name or port is invalid.
Unauthorized
No sync domain exists with the given name.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the sync domain whose backup files should be listed.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Entry in the backup history of a Canton workload describing a single backup artifact: file name, size in bytes, status of the backup operation and the timestamp at which it was produced.
File size in bytes
The supplied domain name is invalid or backup is not supported.
Unauthorized
No sync domain exists with the given name.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the sync domain to query history for.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Single entry in a restore history: filename, status, timestamp and any log captured during the restore.
The supplied domain name is invalid or backup is not supported.
Unauthorized
No sync domain exists with the given name.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the sync domain to query history for.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Entry in the backup history of a Canton workload describing a single backup artifact: file name, size in bytes, status of the backup operation and the timestamp at which it was produced.
File size in bytes
The supplied domain name is invalid or backup is not supported.
Unauthorized
No sync domain exists with the given name.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the HA sync domain.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
High-availability sync domain definition: per-component (sequencer, mediator, topology manager) specifications plus in-cluster or external storage settings.
The supplied HA domain name is invalid.
Unauthorized
No HA sync domain exists with the given name.
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the HA sync domain to delete.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*No Content
No content
The supplied HA domain name is invalid.
Unauthorized
No HA sync domain exists with the given name.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Name of the Canton node whose console output should be returned
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*OK
Invalid node name
Unauthorized
Node or its pod not found
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Name of the application to retrieve
OK
Generic CBM-deployed application: name, container image, port, package, parent validator and Kubernetes resource requirements; used both as a request and a response body on the applications endpoints.
Invalid application name
Unauthorized
Application not found
Internal Server Error
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Name of the application to delete
No Content
No content
Invalid application name
Unauthorized
Application not found
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the validator.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*No Content
No content
Bad Request
Unauthorized
No validator exists with the given name.
Internal Server Error
No content
Bearer JWT issued by the configured OAuth2 / OIDC provider (typically Keycloak or Auth0). Pass as Authorization: Bearer <access_token>.
Kubernetes resource name of the validator.
[a-z]([-a-z0-9]*[a-z0-9])?([a-z0-9]([-a-z0-9]*[a-z0-9])?)*Name of the Kubernetes secret holding the identity dump to delete.
No Content
No content
Bad Request
Unauthorized
No validator or identity dump secret matches the given names.
Internal Server Error
No content
Last updated
Was this helpful?