Documentation/canton-network-docs/Admin APIgRPC APIPackagescom.digitalasset.canton.admin.participant.v30ServicesPruningServiceView on canton-network-docs ↗
canton-network-docs/Admin APIgRPC APIPackagescom.digitalasset.canton.admin.participant.v30ServicesPruningService

GetSafePruningOffset

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

com.digitalasset.canton.admin.participant.v30

​
GetSafePruningOffset

gRPCSince 3.4.0
RPC/com.digitalasset.canton.admin.participant.v30.PruningService/GetSafePruningOffset

​
Protocol Details

​
Inputs

​
GetSafePruningOffsetRequest

before_or_atTimestamp
ledger_endint64
counter_participants_commitments_stateSafeToPruneCommitmentState

​
Outputs

​
GetSafePruningOffsetResponse

safe_pruning_offsetint64
no_safe_pruning_offsetNoSafePruningOffset

​
Lifecycle Changes

3.4.0introduced

com.digitalasset.canton.admin.participant.v30.GetSafePruningOffsetRequest

before_or_atTimestamp
ledger_endint64
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.GetSafePruningOffsetResponse

safe_pruning_offsetint64
no_safe_pruning_offsetNoSafePruningOffset

com.digitalasset.canton.admin.participant.v30.GetSafePruningOffsetResponse.NoSafePruningOffset

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