Cancel a pending or failed job

POST

/admin/jobs/{id}/cancel

• Local development behind nginx (port 8088 by default)

Admin action: move a pending or failed job to cancelled. Cancelling a job that is already running is not supported and returns 409. Gated on system.admin.

Authorizations

• cookieAuth
• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Responses

204

Job cancelled.

401

Authentication required, missing, or invalid

object

error

required

Human-readable error summary

string

Example

the request could not be completed

Example

{
  "error": "authentication required: sign in and retry with a valid session or API token"
}

403

Authenticated but missing required capabilities

object

error

required

Human-readable error summary

string

Example

the request could not be completed

404

Resource not found

object

error

required

Human-readable error summary

string

Example

the request could not be completed

409

Conflict (slug taken, would create cycle, etc.)

object

error

required

Human-readable error summary

string

Example

the request could not be completed