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

GetParticipantSchedule

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

com.digitalasset.canton.admin.participant.v30

​
GetParticipantSchedule

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

​
Protocol Details

​
Inputs

​
GetParticipantScheduleRequest

​
Outputs

​
GetParticipantScheduleResponse

scheduleParticipantPruningSchedule

​
Lifecycle Changes

3.4.0introduced

com.digitalasset.canton.admin.pruning.v30.GetParticipantScheduleRequest

com.digitalasset.canton.admin.pruning.v30.GetParticipantScheduleResponse

scheduleParticipantPruningSchedule

com.digitalasset.canton.admin.pruning.v30.ParticipantPruningSchedule

schedulePruningSchedule
prune_internally_onlybool

com.digitalasset.canton.admin.pruning.v30.PruningSchedule

cronstring
max_durationDuration
retentionDuration
grpcurl
grpcurl
# Add -plaintext if the server is not using TLS.
grpcurl \
  -d @ \
  <HOST:PORT> \
  com.digitalasset.canton.admin.participant.v30.PruningService/GetParticipantSchedule <<'EOF'
{}
EOF
OKapplication/json
OK
{
  "schedule": {
    "schedule": {
      "cron": "string",
      "maxDuration": "string",
      "retention": "string"
    },
    "pruneInternallyOnly": true
  }
}