Documentation/canton-network-docs/Admin APIgRPC APIPackagescom.digitalasset.canton.admin.participant.v30ServicesParticipantRepairServiceView on canton-network-docs ↗
canton-network-docs/Admin APIgRPC APIPackagescom.digitalasset.canton.admin.participant.v30ServicesParticipantRepairService

PurgeContracts

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

com.digitalasset.canton.admin.participant.v30

​
PurgeContracts

gRPCSince 3.4.0
RPC/com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/PurgeContracts

​
Protocol Details

​
Inputs

​
PurgeContractsRequest

synchronizer_aliasstring
contract_idsrepeated string
ignore_already_purgedbool

​
Outputs

​
PurgeContractsResponse

​
Lifecycle Changes

3.4.0introduced

com.digitalasset.canton.admin.participant.v30.PurgeContractsRequest

synchronizer_aliasstring
contract_idsrepeated string
ignore_already_purgedbool

com.digitalasset.canton.admin.participant.v30.PurgeContractsResponse

grpcurl
grpcurl
# Add -plaintext if the server is not using TLS.
grpcurl \
  -d @ \
  <HOST:PORT> \
  com.digitalasset.canton.admin.participant.v30.ParticipantRepairService/PurgeContracts <<'EOF'
{
  "synchronizerAlias": "string",
  "contractIds": [
    "string"
  ],
  "ignoreAlreadyPurged": true
}
EOF
OKapplication/json
OK
{}