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!

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

Error responses

Error Name
`PauseSchedulePermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	Could not pause the Schedule.
	Parameters	`scheduleRid`

See Errors for a general overview of errors in the platform.