Jobs

Cancel a job

Requests cancellation. A job that has not started is cancelled immediately; a running job is signalled and terminalises shortly after. Cancellation is idempotent.

post/jobs/{id}/cancel

Request

  • Base URL: https://api.latchkey.dev
  • URL: https://api.latchkey.dev/jobs/{id}/cancel
  • Auth: HTTP bearer

Response

Cancellation recorded.

job_idstring required

Identifier of the job.

state'created' | 'queued' | 'provisioning' | 'running' | 'succeeded' | 'failed' | 'cancelled' | 'expired' required

Job lifecycle state. succeeded, failed, cancelled and expired are terminal.

cancel_requestedboolean required

Always true once cancellation has been recorded.

Changes

No recorded changes to this operation across all 1 revision of this API.