Sign in
Querator V1

Clear a queue

Clears all data from a queue, optionally clears all defer and scheduled items

post/v1/queue.clear

Request body

queue_namestring required

The name of the queue to clear

deferboolean required

Indicates the 'defer' queue will be cleared. If true, any items scheduled to be retried at a future date will be removed.

scheduledboolean required

Indicates any 'scheduled' items in the queue will be cleared. If true, any items scheduled to be enqueued at a future date will be removed.

queueboolean required

Indicates any items currently waiting in the FIFO queue will clear. If true, any items in the queue which have NOT been reserved will be removed.

destructivestring required

Indicates the Defer,Scheduled,Queue operations should be destructive in that all data regardless of status will be removed.

For example, if used with ClearRequest.Queue = true, then ALL items in the queue regardless of reserve status will be removed. This means that clients who currently have ownership of those items will not be able to "complete" those items, as querator will have no knowledge of those items.

Response

codeinteger required
code_textstring required
messagestring required

Changes