Jobs

Get job status

Returns the current state of one job, including exit code and failure reason once terminal. A submitted job that has not started within one hour is reported as expired.

get/jobs/{id}

Request

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

Response

Current job status.

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.

runner_size'small' | 'medium' | 'large' | 'xlarge' required

Latchkey runner t-shirt size. Determines vCPU and memory.

timeout_secondsinteger required

Wall-clock limit in seconds.

cancel_requestedboolean

Whether cancellation has been requested.

exit_codeinteger nullable

Process exit code once the command has finished.

failure_reasonstring nullable

Why the job failed, when it did.

created_atstring date-time required
submitted_atstring date-time nullable
started_atstring date-time nullable
completed_atstring date-time nullable

Changes

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