Skip to main content
Version: 8.6

Update a job

PATCH 

/jobs/:jobKey

Update a job with the given key.

Request

Path Parameters

    jobKey int64required

    The key of the job to update.

Body

required
    changeset objectrequired

    JSON object with changed job attribute values.

    The following attributes can be adjusted with this endpoint, additional attributes will be ignored:

    • retries - The new amount of retries for the job; must be a positive number.
    • timeout - The duration of the new timeout in ms, starting from the current moment.

    Providing any of those attributes with a null value or omitting it preserves the persisted attribute’s value.

    The job cannot be completed or failed with this endpoint, use the complete job or fail job endpoints instead.

    retries int32nullable

    The new amount of retries for the job; must be a positive number.

    timeout int64nullable

    The duration of the new timeout in ms, starting from the current moment.

Responses

The job was updated successfully.

Loading...