Shotstash
API referenceREST referencePipeline

Release the job

Puts a claimed or running job back in the queue without spending an attempt (use it on shutdown). Another worker can claim it at once.

Try the REST routes against the public demo at https://demostash.aldyernesto.my.id. Get a read-only token (valid for 60 minutes), then paste it as the Bearer token in the console of any route.

POST
/api/v1/pipeline/jobs/{id}/release

Puts a claimed or running job back in the queue without spending an attempt (use it on shutdown). Another worker can claim it at once.

Authorization

WorkerToken
headerX-Worker-Token<token>

Per-worker token returned once by worker registration.

Path Parameters

id*string

Job id (UUID).

Header Parameters

X-Claim-Token*string

Claim token from the claim answer.

Request Body

application/json
  1. body
[key: string]?not (unknown)

Response Body

Job back in the queue

application/json
  1. response
status*"queued"

Always queued: the job is back in the queue.

Value in"queued"
attempts*number

Attempts spent so far (unchanged by a release).

curl -X POST "https://example.com/api/v1/pipeline/jobs/string/release" \  -H "X-Claim-Token: string" \  -H "Content-Type: application/json" \  -d '{    "property1": null,    "property2": null  }'
{  "status": "queued",  "attempts": 0}