v1

latestOpenAPI 3.1.0Apache 2.02026-07-17143043.7 KB

Querator V1

Update a queue

Update the details of a queue.

post/v1/queues.update

Request body

queue_namestring required

The name of the queue

created_atstring date-time required

The timestamp the queue was created

updated_atstring date-time required

The timestamp the queue was last updated

dead_queuestring required

The name of the dead letter queue for this queue. If this is a dead letter queue then this field will be empty when retrieved via /queue.list

referencestring required

This is a user supplied field which could contain metadata or specify who owns this queue

lease_timeoutstring required

The default lease timeout for this queue

expire_timeoutstring required

How long an item can wait in the queue regardless of attempts before it is moved to the dead letter queue

max_attemptsinteger required

The maximum number of times an item can be retried by a consumer before it is placed in the dead letter queue or removed. Infinite attempts if max_attempts is set to '0'. lease_timeout violations are included as attempts

requested_partitionsinteger required

The number of partitions this queue has requested. This might be different than the number of currently active partitions as the system grows or contracts the number of partitions.

Example request

{
  "queue_name": "queue-name",
  "created_at": "2024-01-01 12:00:00.0000",
  "updated_at": "2024-01-01 12:00:00.0000",
  "dead_queue": "queue-name-dead",
  "reference": "jake@statefarm.com",
  "lease_timeout": "60m",
  "expire_timeout": "24h"
}

Response

codeinteger required

Response status code

code_textstring

Human readable status message

messagestring

Additional details about the response