Querator V1

Clear a queue

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

post/v1/queue.clear

Request body

queue_namestring required

The name of the queue to clear

retryboolean required

Indicates the 'retry' 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 leased will be removed.

destructiveboolean required

Indicates the Retry, 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 lease 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

Response status code

code_textstring

Human readable status message

messagestring

Additional details about the response

Changes

Changed in 5 of the 16 revisions of this API.824

Jul 17, 2026b67c2fa641f71See the full diff
- ▲
  request body became required
  request-body-became-required
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 5, 2025db1e2b747f3c3See the full diff
- ▲
  the response property code_text became optional for the status 200
  response-property-became-optional
- ▲
  the response property message became optional for the status 200
  response-property-became-optional
- ▲
  removed the required property details from the response with the 200 status
  response-required-property-removed
Apr 21, 20253de0078c926811See the full diff
- ▲
  added the new required request property retry
  new-required-request-property
- ●
  removed the request property defer
  request-property-removed
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 16, 202422a36c3740921See the full diff
- ▲
  the destructive request property type/format changed from string/ to boolean/
  request-property-type-changed
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 15, 2024ba3240950bb2214See the full diff
- ▲
  added the new required request property defer
  new-required-request-property
- ▲
  the destructive request property type/format changed from boolean/ to string/
  request-property-type-changed
- ●
  removed the request property retry
  request-property-removed
- ○
  request body became optional
  request-body-became-optional
- ○
  the response property code_text became required for the status 200
  response-property-became-required
- ○
  the response property message became required for the status 200
  response-property-became-required
- ○
  added the required property details to the response with the 200 status
  response-required-property-added
This revision also has 18 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history