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

SetParticipantSchedule

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

com.digitalasset.canton.admin.participant.v30

​
SetParticipantSchedule

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

​
Protocol Details

​
Inputs

​
SetParticipantScheduleRequest

scheduleParticipantPruningSchedule

​
Outputs

​
SetParticipantScheduleResponse

​
Lifecycle Changes

3.4.0introduced

com.digitalasset.canton.admin.pruning.v30.SetParticipantScheduleRequest

scheduleParticipantPruningSchedule

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

schedulePruningSchedule
prune_internally_onlybool

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

cronstring
max_durationDuration
retentionDuration

com.digitalasset.canton.admin.pruning.v30.SetParticipantScheduleResponse

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