Skip to main content

Pause Schedule

Endpoint: GET /api/scheduler/schedules/{name}/pause

Pauses a currently running schedule.

Path parameters

ParameterDescriptionTypeRequired/ Optional
nameThe name of the schedule to pause.stringRequired.

Response

  • Returns 200 OK, indicating that the schedule is paused. If the schedule is already paused, it returns 200 OK with no change to the schedule state.
  • Returns 404 if the schedule does not exist.

Examples

Pause a schedule

Request

curl -X 'GET' \
'https://<YOUR-CLUSTER>/api/scheduler/schedules/assignPRSchedule/pause' \
-H 'accept: application/json' \
-H 'X-Authorization: <TOKEN>'

Response

Returns 200 OK, indicating that the schedule is paused.