Renew a lease

Last updated Oct 2, 2026

POST /spools/{spool}/renew

Resets the lease expiry to now plus the lease's queue's current lease timeout — a reset, not an extension: after a settings update the new expiry can land earlier than the previous one, or go away. On a queue with no lease timeout the lease never expires and Spooler-Lease-Expires-At is absent, even for a lease granted with a deadline before the timeout was removed. A message discarded by handle while leased makes the renew answer 410 stale_token, like any settle: renewing on a schedule is how a long-running worker learns its task was cancelled.

Sample

curl -si -X POST "$SPOOLER_API/spools/<spool>/renew" \
  -H "Authorization: Bearer $SPOOLER_KEY" \
  -H "Spooler-Lease: <lease>"

Parameters

Name	In	Type	Required	Description
spool	path	IdentName, 1–63 chars, ^[A-Za-z0-9_:-]+$	yes	The spool name.
Spooler-Lease	header	Lease, 16–256 chars, ^[A-Za-z0-9_-]+$	yes	The lease from a receive, presented back.

Responses

Status	Description
204	Renewed.
400	The request is malformed; the kind names the problem.
401	The API key is missing or not recognized.
402	The account is suspended.
403	A plan limit refuses the operation; the kind names it. A 403 without a kind, on any operation, means the API key is blocked.
404	The spool or queue does not exist; the kind says which.
409	Concurrent state refuses the operation; the kind names it.
410	The lease no longer settles anything: expired, already settled, or predates a primary change.
429	The per-account request rate cap is exceeded. The body names the kind (rate_limited); the wait is the Retry-After header and is not repeated in the body. Headers are as structured as the body, and this one is the header HTTP defines for a wait.
503	The spool is momentarily unavailable.

204 headers

Header	Description
Spooler-Lease-Expires-At	The new absolute expiry (RFC 3339, UTC). Absent when the queue has no lease timeout: the lease never expires.

429 headers

Header	Description
Retry-After	Seconds until the next request is admitted, whole and at least 1; always the delay-seconds form, never an HTTP-date.