Skip to content

Recover a failed message

Last updated 

POST /spools/{spool}/recover

Returns the failed message to its queue with its retries reset — the handle names the queue; Spooler-Delay-Seconds postpones its visibility.

Sample ​

sh
curl -X POST "$SPOOLER_API/spools/<spool>/recover" \
  -H "Authorization: Bearer $SPOOLER_KEY" \
  -H "Spooler-Handle: <handle>"

Parameters ​

NameInTypeRequiredDescription
spoolpathIdentName, 1–63 chars, ^[A-Za-z0-9_:-]+$yesThe spool name.
Spooler-HandleheaderHandle, 16–256 chars, ^[A-Za-z0-9_-]+$yesThe handle from a failed-state listing, presented back.
Spooler-Delay-Secondsheaderinteger, 0–604,800noSeconds until the recovered message becomes visible, at most a week. Omitted or 0 means immediately visible.

Responses ​

StatusDescription
204Recovered.
400The request is malformed; the kind names the problem.
401The API key is missing or not recognized.
402The account is suspended.
403A plan limit refuses the operation; the kind names it. A 403 without a kind, on any operation, means the API key is blocked.
404The spool or queue does not exist; the kind says which.
409Concurrent state refuses the operation; the kind names it.
410The lease no longer settles anything: expired, already settled, or predates a primary change.
429The 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.
500The server failed; kind operation_unconfirmed means the write was accepted but its durability is unknown.
503The spool is momentarily unavailable.

429 headers ​

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