Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Nack a queue
Returns leased messages to the Queue after `delay`; each nack counts as a delivery.
This method is not served on the public API.
api.sylphx.comdoes not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.
Returns leased messages to the Queue after delay; each nack counts as a delivery.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/queues/queue:nack - Scope
events:write - Effect
write— a successful call changes state. - Collection queues
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the queue. Required. |
leases | MessageLease[] | The leases to nack, at most 100. Required. |
delay | duration | Hide the messages this long before the next lease. |
#MessageLease
| Field | Type | What it is |
|---|---|---|
message_id | string | The message id. Required. |
lease_generation | int64 | The lease fence: the lease generation this holder was granted. Required. |
#Response
| Field | Type | What it is |
|---|---|---|
stale_leases | MessageLease[] | Leases that were stale and not applied. |
#MessageLease
| Field | Type | What it is |
|---|---|---|
message_id | string | The message id. Required. |
lease_generation | int64 | The lease fence: the lease generation this holder was granted. Required. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.INVALID_FIELD— A field failed validation.
Every error arrives in the body Errors describes.
#Examples
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/queues/queue:nack" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"leases":[{"lease_generation":1,"message_id":"…"}]}'