Skip to main content
Version: 8.6

Fail job

POST 

/jobs/:jobKey/failure

Mark the job as failed

Request

Path Parameters

    jobKey int64required

    The key of the job to fail.

Body

    retries int32

    The amount of retries the job should have left

    errorMessage stringnullable

    An optional message describing why the job failed. This is particularly useful if a job runs out of retries and an incident is raised, as this message can help explain why an incident was raised.

    retryBackOff int64

    The backoff timeout (in ms) for the next retry.

    variables objectnullable

    JSON object that will instantiate the variables at the local scope of the job's associated task.

    property name* anynullable

    Additional properties allowed.

Responses

The job is failed.

Loading...