CCPEDIAby Unity Nodes
Documentation/Canton Network docs/Admin API › gRPC API › Packages › com.digitalasset.canton.admin.participant.v30 › Services › PruningServiceView on Canton Network docs ↗

Prune

Participant Administration›Protobuf›com.digitalasset.canton.admin.participant.v30›Prune

com.digitalasset.canton.admin.participant.v30

​
Prune

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

​
Protocol Details

ProtocolgRPC
ServicePruningService
RPCPrune
Client streamNo
Server streamNo

​
Inputs

​
PruneRequest

Messagecom.digitalasset.canton.admin.participant.v30.PruneRequest
Client streamNo
prune_up_toint64
counter_participants_commitments_stateSafeToPruneCommitmentState

​
Outputs

​
PruneResponse

Messagecom.digitalasset.canton.admin.participant.v30.PruneResponse
Server streamNo

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
{}