Skip to content
Console
On this page

Ack a queue

Acknowledges leased messages; each is removed.

Acknowledges leased messages; each is removed. A lease that is stale (expired or superseded) is reported, not applied.

  • Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/queues/queue:ack
  • Scope events:write
  • Effect write — a successful call changes state.
  • Collection queues

Request

FieldTypeWhat it is
namestringThe name of the queue. Required.
leasesMessageLease[]The leases to ack, at most 100. Required.

MessageLease

FieldTypeWhat it is
message_idstringThe message id. Required.
lease_generationint64The lease fence: the lease generation this holder was granted. Required.

Response

FieldTypeWhat it is
stale_leasesMessageLease[]Leases that were stale and not applied.

MessageLease

FieldTypeWhat it is
message_idstringThe message id. Required.
lease_generationint64The lease fence: the lease generation this holder was granted. Required.

Errors

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:ack" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"leases":[{"lease_generation":1,"message_id":"…"}]}'