API Reference
Search documentation
karat

+

K

User Documentation ↗

Pause Schedule

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

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

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

Path parameters

scheduleRid
string

The Resource Identifier (RID) of a Schedule.

Query parameters

preview
boolean
optional

Enables the use of preview functionality.

Examples

Request

Copied!
1 2 3 curl -X POST \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/orchestration/schedules/ri.scheduler.main.schedule.8843955e-37d1-4363-85eb-539833e10a41/pause?preview=true"