Skip to main content

Pause Schedules in Bulk

Endpoint: PUT /api/scheduler/bulk/pause

Pauses one or more running schedules in bulk.

Request body

Format the request body as an array of strings containing the schedule names. For example, ["schedule-name-1", "schedule-name-2"].

Response

ParameterDescription
bulkSuccessfulResultsNames of schedules that were successfully paused.
bulkErrorResultsNames of schedules that failed to pause, with corresponding error messages.

Examples

Pause schedules in bulk

Request

curl -X 'PUT' \
'https://<YOUR-SERVER-URL>/api/scheduler/bulk/pause' \
-H 'accept: */*' \
-H 'X-Authorization: <TOKEN>' \
-H 'Content-Type: application/json' \
-d '[
"assignPRSchedule",
"AutomateEndpointMonitoring",
"emailNurturingAutomation",
"userCreated"
]'

Response

{
"bulkErrorResults": {},
"bulkSuccessfulResults": [
"assignPRSchedule",
"AutomateEndpointMonitoring",
"emailNurturingAutomation",
"userCreated"
]
}
Pause schedules in bulk: partial failure

Request

curl -X 'PUT' \
'https://<YOUR-SERVER-URL>/api/scheduler/bulk/pause' \
-H 'accept: */*' \
-H 'X-Authorization: <TOKEN>' \
-H 'Content-Type: application/json' \
-d '[
"assignPRSchedule",
"AutomateEndpointMonitoring",
"emailNurturingAutomation",
"userCreateds"
]'

Response

{
"bulkErrorResults": {
"userCreateds": "Schedule 'userCreateds' not found"
},
"bulkSuccessfulResults": [
"assignPRSchedule",
"AutomateEndpointMonitoring",
"emailNurturingAutomation"
]
}