Queues

queues

Methods

Create Queue -> Envelope<>
post/accounts/{account_id}/queues

Create a new queue

Security

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Queues Write Workers Scripts Write

Parameters
account_id: string
(maxLength: 32)

A Resource identifier.

Response fields
errors: Array<>
Optional
(minLength: 1)
messages: Array<string>
Optional
result:
Optional
success: true
Optional

Indicates if the API call was successful or not.

Request example
200Example
Delete Queue -> { errors, messages, success }
delete/accounts/{account_id}/queues/{queue_id}

Deletes a queue

Get Queue -> Envelope<>
get/accounts/{account_id}/queues/{queue_id}

Get details about a specific queue.

List Queues -> SinglePage<>
get/accounts/{account_id}/queues

Returns the queues owned by an account.

Update Queue -> Envelope<>
put/accounts/{account_id}/queues/{queue_id}

Updates a Queue. Note that this endpoint does not support partial updates. If successful, the Queue's configuration is overwritten with the supplied configuration.

Domain types

Queue = { consumers, consumers_total_count, created_on, 6 more... }
Queues

Consumers

queues.consumers

Methods

Create A Queue Consumer -> Envelope<>
post/accounts/{account_id}/queues/{queue_id}/consumers

Creates a new consumer for a Queue

Delete Queue Consumer -> { errors, messages, success }
delete/accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}

Deletes the consumer for a queue.

List Queue Consumers -> SinglePage<>
get/accounts/{account_id}/queues/{queue_id}/consumers

Returns the consumers for a Queue

Update Queue Consumer -> Envelope<>
put/accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}

Updates the consumer for a queue, or creates one if it does not exist.

Domain types

Consumer = { consumer_id, created_on, queue_id, 4 more... } | { consumer_id, created_on, queue_id, 2 more... }
Queues

Messages

queues.messages

Methods

Acknowledge Retry Queue Messages -> Envelope<{ ackCount, retryCount, warnings }>
post/accounts/{account_id}/queues/{queue_id}/messages/ack

Acknowledge + Retry messages from a Queue

Pull Queue Messages -> SinglePage<{ id, attempts, body, 3 more... }>
post/accounts/{account_id}/queues/{queue_id}/messages/pull

Pull a batch of messages from a Queue