Cloudflare API | Queues › Update Queue

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

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

path Parameters

account_id: string

(maxLength: 32)

A Resource identifier.

queue_id: string

(maxLength: 32)

A Resource identifier.

Response fields

errors: Array<

ResponseInfo

Optional

(minLength: 1)

messages: Array<string>

Optional

result:

Queue

Optional

success: true

Optional

Indicates if the API call was successful or not.

Request example

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/queues/$QUEUE_ID \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "errors": [
    {
      "code": 7003,
      "message": "No route for the URI",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    "string"
  ],
  "result": {
    "queue_name": "example-queue",
    "settings": {
      "delivery_delay": 5,
      "delivery_paused": true,
      "message_retention_period": 345600
    }
  },
  "success": true
}

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.

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.