purge

Creates, updates, deletes, gets or lists a purge resource.

Overview

Name	purge
Type	Resource
Id	cloudflare.queues.purge

Fields

The following fields are returned by SELECT queries:

list

Details of the requested Queue

Name	Datatype	Description
completed	string	Indicates if the last purge operation completed successfully.
started_at	string	Timestamp when the last purge operation started.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	queue_id, account_id		Get details about a Queue's purge status.
start	exec	queue_id, account_id		Deletes all messages from the Queue.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	The Cloudflare account ID.
queue_id	string	The Cloudflare Queue ID.

SELECT examples

list

Get details about a Queue's purge status.

SELECT
completed,
started_at
FROM cloudflare.queues.purge
WHERE queue_id = '{{ queue_id }}' -- required
AND account_id = '{{ account_id }}' -- required
;

Lifecycle Methods

start

Deletes all messages from the Queue.

EXEC cloudflare.queues.purge.start 
@queue_id='{{ queue_id }}' --required, 
@account_id='{{ account_id }}' --required 
@@json=
'{
"delete_messages_permanently": {{ delete_messages_permanently }}
}'
;