Pause jobs of one type
POST
/api/v1/admin/jobs/{kind}/pause
const url = 'https://example.com/api/v1/admin/jobs/example/pause';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"reason":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/admin/jobs/example/pause \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "reason": "example" }'Pauses the jobs of one type. It requires a signed-in User with the admin scope and the admin or owner Role. It can return 400 if the request is invalid, 401 if the session is missing or expired, 403 if access is denied, 404 if the requested item does not exist and 503 if the service is temporarily unavailable. Route: /api/v1/admin/jobs/{kind}/pause. Inputs: kind. A recent account assertion is required. Do not automatically replay this operation after an uncertain result.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”kind
required
string
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
reason
required
string
Examplegenerated
{ "reason": "example"}Responses
Section titled “Responses”Media typeapplication/json
object
kind
required
string
paused
required
boolean
paused_at
string | null
reason
string | null
Examplegenerated
{ "kind": "example", "paused": true, "paused_at": "example", "reason": "example"}