Skip to content
CCPEDIAby Unity Nodes
Documentation/Canton Network Docs/Admin APIgRPC APIPackagescom.digitalasset.canton.admin.participant.v30ServicesPruningServiceView on Canton Network Docs

Prune

Participant AdministrationProtobufcom.digitalasset.canton.admin.participant.v30Prune

com.digitalasset.canton.admin.participant.v30

Prune

gRPC
RPC/com.digitalasset.canton.admin.participant.v30.PruningService/Prune

Protocol Details

Inputs

PruneRequest

prune_up_toint64
counter_participants_commitments_stateSafeToPruneCommitmentState

Outputs

PruneResponse

com.digitalasset.canton.admin.participant.v30.PruneRequest

prune_up_toint64
counter_participants_commitments_stateSafeToPruneCommitmentState

com.digitalasset.canton.admin.participant.v30.SafeToPruneCommitmentState

  • SAFE_TO_PRUNE_COMMITMENT_STATE_UNSPECIFIED
  • SAFE_TO_PRUNE_COMMITMENT_STATE_MATCH
  • SAFE_TO_PRUNE_COMMITMENT_STATE_MATCH_MISMATCH
  • SAFE_TO_PRUNE_COMMITMENT_STATE_ALL

com.digitalasset.canton.admin.participant.v30.PruneResponse

grpcurl
grpcurl
# Add -plaintext if the server is not using TLS.
grpcurl \
  -d @ \
  <HOST:PORT> \
  com.digitalasset.canton.admin.participant.v30.PruningService/Prune <<'EOF'
{
  "pruneUpTo": "0",
  "counterParticipantsCommitmentsState": "SAFE_TO_PRUNE_COMMITMENT_STATE_UNSPECIFIED"
}
EOF
OKapplication/json
OK
{}