Stop a job

DELETE

/api/v1/admin/jobs/{id}

const url = 'https://example.com/api/v1/admin/jobs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://example.com/api/v1/admin/jobs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Stops a job. It requires a signed-in User with the admin scope and the admin or owner Role. It can return 401 if the session is missing or expired, 403 if access is denied, 404 if the requested item does not exist, 409 if the request conflicts with the current state and 503 if the service is temporarily unavailable. Route: /api/v1/admin/jobs/{id}. Inputs: id. A recent account assertion is required. Do not automatically replay this operation after an uncertain result.

Authorizations

installationBearer
browserSession

Parameters

Path Parameters

required

string format: uuid

Responses

202

application/json

object

affected

required

integer format: int64

outcome

string | null

Example^generated

{
  "affected": 1,
  "outcome": "example"
}