Skip to content
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

SetSchedule

Participant AdministrationProtobufcom.digitalasset.canton.admin.participant.v30SetSchedule

com.digitalasset.canton.admin.participant.v30

SetSchedule

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

Protocol Details

Inputs

SetScheduleRequest

schedulePruningSchedule

Outputs

SetScheduleResponse

Lifecycle Changes

3.4.0introduced

com.digitalasset.canton.admin.pruning.v30.SetScheduleRequest

schedulePruningSchedule

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

cronstring
max_durationDuration
retentionDuration

com.digitalasset.canton.admin.pruning.v30.SetScheduleResponse

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