Skip to content

Record a failure on a running job

POST
/jobs/{id}/fail

If terminal=true the job goes straight to status=failed and will not be retried. Otherwise the job returns to pending unless its attempts count reached max_attempts.

id
required
string format: uuid
object
worker_id
required
string
>= 1 characters <= 200 characters
error
required
string
terminal
boolean

Failure recorded

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"
}

Lease lost