Sign in
Querator V1

Delete a queue

Delete a queue and all associated data. Use the force parameter to delete queues that have active items or leases.

post/v1/queues.delete

Request body

queue_namestring required

The name of the queue to delete

forceboolean required

force indicates the deletion should ignore any current open leases or items in the queue and delete all data related to the queue. In addition, this forcibly cancels all in progress client lease requests.

Example request

{
  "queue_name": "queue-name"
}

Response

codeinteger required

Response status code

code_textstring

Human readable status message

messagestring

Additional details about the response

Changes

Changed in 3 of the 16 revisions of this API.21