Cloudflare API

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<

Consumer

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.

Get Queue Consumer -> Envelope<

Consumer

get/accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}

Fetches the consumer for a queue by consumer id

List Queue Consumers -> SinglePage<

Consumer

get/accounts/{account_id}/queues/{queue_id}/consumers

Returns the consumers for a Queue

Update Queue Consumer -> Envelope<

Consumer

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

Push Message Batch -> { errors, messages, success }

post/accounts/{account_id}/queues/{queue_id}/messages/batch

Push a batch of message to a Queue

Pull Queue Messages -> Envelope<{ message_backlog_count, messages }>

post/accounts/{account_id}/queues/{queue_id}/messages/pull

Pull a batch of messages from a Queue

Push Message -> { errors, messages, success }

post/accounts/{account_id}/queues/{queue_id}/messages

Push a message to a Queue

Queues

Purge

queues.purge

Methods

Purge Queue -> Envelope<

Queue

post/accounts/{account_id}/queues/{queue_id}/purge

Deletes all messages from the Queue.

Get Queue Purge Status -> Envelope<{ completed, started_at }>

get/accounts/{account_id}/queues/{queue_id}/purge

Get details about a Queue's purge status.

Queues

Subscriptions

queues.subscriptions

Methods

Create Event Subscription -> Envelope<{ id, created_at, destination, 5 more... }>

post/accounts/{account_id}/event_subscriptions/subscriptions

Create a new event subscription for a queue

Delete Event Subscription -> Envelope<{ id, created_at, destination, 5 more... }>

delete/accounts/{account_id}/event_subscriptions/subscriptions/{subscription_id}

Delete an existing event subscription

List Event Subscriptions -> V4PagePaginationArray<{ id, created_at, destination, 5 more... }>

get/accounts/{account_id}/event_subscriptions/subscriptions

Get a paginated list of event subscriptions with optional sorting and filtering

Update Event Subscription -> Envelope<{ id, created_at, destination, 5 more... }>

patch/accounts/{account_id}/event_subscriptions/subscriptions/{subscription_id}

Update an existing event subscription