--- title: Purge Queue --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [Queues](https://developers.cloudflare.com/api/resources/queues) [Purge](https://developers.cloudflare.com/api/resources/queues/subresources/purge) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Purge Queue POST/accounts/{account\_id}/queues/{queue\_id}/purge Starts a purge that deletes all messages from a Queue. ##### Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

##### Accepted Permissions (at least one required) `Queues Write``Workers Scripts Write` ##### P ath ParametersExpand Collapse account\_id: string A Resource identifier. maxLength32 [Link to this property](<#(resource)%20queues.purge%20%3E%20(method)%20start%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) queue\_id: string A Resource identifier. maxLength32 [Link to this property](<#(resource)%20queues.purge%20%3E%20(method)%20start%20%3E%20(params)%20default%20%3E%20(param)%20queue_id%20%3E%20(schema)>) ##### Body ParametersJSONExpand Collapse delete\_messages\_permanently: optional boolean Confirms that all messages will be permanently deleted. [Link to this property](<#(resource)%20queues.purge%20%3E%20(method)%20start%20%3E%20(params)%200%20%3E%20(param)%20delete_messages_permanently%20%3E%20(schema)>) ##### ReturnsExpand Collapse

errors: optional array of ResponseInfo { code, message, documentation\_url, source } minLength1

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

[Link to this property](<#(resource)%20queues.purge%20%3E%20(method)%20start%20%3E%20(network%20schema)%20%3E%20(property)%20errors>) messages: optional array of string [Link to this property](<#(resource)%20queues.purge%20%3E%20(method)%20start%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)

result: optional Queue { consumers, consumers\_total\_count, created\_on, 7 more }

consumers: optional array of Consumer

One of the following:

Worker object {consumer\_id, created\_on, dead\_letter\_queue, 4 more }

consumer\_id: optional string A Resource identifier. maxLength32 Link to this property created\_on: optional string formatdate-time Link to this property dead\_letter\_queue: optional string Name of the dead letter queue, or empty string if not configured Link to this property queue\_name: optional string Link to this property script\_name: optional string Name of a Worker Link to this property

settings: optional object {batch\_size, max\_concurrency, max\_retries, 2 more }

batch\_size: optional number The maximum number of messages to include in a batch. Link to this property max\_concurrency: optional number Maximum number of concurrent consumers that may consume from this Queue. Set to null to automatically opt in to the platform’s maximum (recommended). Link to this property max\_retries: optional number The maximum number of retries Link to this property max\_wait\_time\_ms: optional number The number of milliseconds to wait for a batch to fill up before attempting to deliver it Link to this property retry\_delay: optional number The number of seconds to delay before making the message available for another attempt. Link to this property

Link to this property type: optional "worker" Link to this property

Link to this property

HTTPPull object {consumer\_id, created\_on, dead\_letter\_queue, 3 more }

settings: optional object {batch\_size, max\_retries, retry\_delay, visibility\_timeout\_ms }

batch\_size: optional number The maximum number of messages to include in a batch. Link to this property max\_retries: optional number The maximum number of retries Link to this property retry\_delay: optional number The number of seconds to delay before making the message available for another attempt. Link to this property visibility\_timeout\_ms: optional number The number of milliseconds that a message is exclusively leased. After the timeout, the message becomes available for another attempt. Link to this property

Link to this property type: optional "http\_pull" Link to this property

Link to this property

Link to this property consumers\_total\_count: optional number Link to this property created\_on: optional string Link to this property

jurisdiction: optional "eu"or "us"or "fedramp"

One of the following: "eu" Link to this property "us" Link to this property "fedramp" Link to this property

Link to this property modified\_on: optional string Link to this property

producers: optional array of object {script, type } or object {bucket\_name, type }

One of the following:

MqWorkerProducer object {script, type }

script: optional string Link to this property type: optional "worker" Link to this property

Link to this property

MqR2Producer object {bucket\_name, type }

bucket\_name: optional string Link to this property type: optional "r2\_bucket" Link to this property

Link to this property

Link to this property producers\_total\_count: optional number Link to this property queue\_id: optional string Link to this property queue\_name: optional string Link to this property

settings: optional object {delivery\_delay, delivery\_paused, message\_retention\_period }

delivery\_delay: optional number Number of seconds to delay delivery of all messages to consumers. Link to this property delivery\_paused: optional boolean Indicates if message delivery to consumers is currently paused. Link to this property message\_retention\_period: optional number Number of seconds after which an unconsumed message will be delayed. Link to this property

Link to this property

[Link to this property](<#(resource)%20queues.purge%20%3E%20(method)%20start%20%3E%20(network%20schema)%20%3E%20(property)%20result>) success: optional true Indicates if the API call was successful or not. [Link to this property](<#(resource)%20queues.purge%20%3E%20(method)%20start%20%3E%20(network%20schema)%20%3E%20(property)%20success>) ### Purge Queue HTTP HTTPTypeScriptPythonGoTerraform ``` curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/queues/$QUEUE_ID/purge \ -X POST \ -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" ``` 200 example ``` { "errors": [ { "code": 7003, "message": "No route for the URI", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ "string" ], "result": { "consumers": [ { "consumer_id": "023e105f4ecef8ad9ca31a8372d0c353", "created_on": "2019-12-27T18:11:19.117Z", "dead_letter_queue": "dead_letter_queue", "queue_name": "example-queue", "script_name": "my-consumer-worker", "settings": { "batch_size": 50, "max_concurrency": 10, "max_retries": 3, "max_wait_time_ms": 5000, "retry_delay": 10 }, "type": "worker" } ], "consumers_total_count": 0, "created_on": "created_on", "jurisdiction": "eu", "modified_on": "modified_on", "producers": [ { "script": "script", "type": "worker" } ], "producers_total_count": 0, "queue_id": "queue_id", "queue_name": "example-queue", "settings": { "delivery_delay": 5, "delivery_paused": true, "message_retention_period": 345600 } }, "success": true } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 7003, "message": "No route for the URI", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ "string" ], "result": { "consumers": [ { "consumer_id": "023e105f4ecef8ad9ca31a8372d0c353", "created_on": "2019-12-27T18:11:19.117Z", "dead_letter_queue": "dead_letter_queue", "queue_name": "example-queue", "script_name": "my-consumer-worker", "settings": { "batch_size": 50, "max_concurrency": 10, "max_retries": 3, "max_wait_time_ms": 5000, "retry_delay": 10 }, "type": "worker" } ], "consumers_total_count": 0, "created_on": "created_on", "jurisdiction": "eu", "modified_on": "modified_on", "producers": [ { "script": "script", "type": "worker" } ], "producers_total_count": 0, "queue_id": "queue_id", "queue_name": "example-queue", "settings": { "delivery_delay": 5, "delivery_paused": true, "message_retention_period": 345600 } }, "success": true } ```