Skip to content

Extend the lease on a running job

POST
/jobs/{id}/heartbeat

Workers should call this faster than the lease window (default 5 minutes). Returns 409 if the lease was already taken by another worker.

id
required
string format: uuid

Body for heartbeat; identifies the worker holding the lease.

object
worker_id
required
string
>= 1 characters <= 200 characters

Lease extended

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 — another worker took the job