Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Pause Schedule

POST/api/v2/orchestration/schedules/{scheduleRid}/pause

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:orchestration-write.

Path parameters

scheduleRid
string

The RID of a Schedule.

Examples

Request

Copied!
1 2 3 curl -X POST \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/orchestration/schedules/ri.scheduler.main.schedule.5ad5c340-59f3-4a60-9fc6-161bb984f871/pause"

Error responses

Error Name
PauseSchedulePermissionDeniedError CodePERMISSION_DENIED
Status Code403
DescriptionCould not pause the Schedule.
ParametersscheduleRid