Cloudflare API | Queues › Update Queue

API Reference

Account & User Management

Resource Sharing

AI

Certificate Management

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

Domain/Zone Management

IP Addresses

Media

Networking

Magic Cloud Networking

Magic Network Monitoring

Network Interconnects

Observability

Security Center

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Schema Validation

Content Scanning

Leaked Credential Checks

Token Validation

Storage & Databases

Threat Intelligence

Brand Protection

Workers & Pages

Browser Rendering

Durable Objects

Workers For Platforms

Shared

Queues

queues

Methods

List Queues -> SinglePage<

>

get/accounts/{account_id}/queues

Returns the queues owned by an account.

Get Queue -> Envelope<

>

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

Get details about a specific queue.

Create Queue -> Envelope<

>

post/accounts/{account_id}/queues

Create a new queue

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.

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<

>

Optional

(minLength: 1)

messages: Array<string>

Optional

result:

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": {
    "consumers": [
      {
        "consumer_id": "023e105f4ecef8ad9ca31a8372d0c353",
        "created_on": "created_on",
        "queue_id": "023e105f4ecef8ad9ca31a8372d0c353",
        "script": "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",
    "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
}

Update Queue -> Envelope<

>

patch/accounts/{account_id}/queues/{queue_id}

Updates a Queue.

Delete Queue -> { errors, messages, success }

delete/accounts/{account_id}/queues/{queue_id}

Deletes a queue

Domain types

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

Consumers

queues.consumers

Methods

List Queue Consumers -> SinglePage<

>

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

Returns the consumers for a Queue

Create A Queue Consumer -> Envelope<

>

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

Creates a new consumer 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.

Delete Queue Consumer -> { errors, messages, success }

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

Deletes the consumer for a queue.

Domain types

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

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

Purge

queues.purge

Methods

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

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

Get details about a Queue's purge status.

Purge Queue -> Envelope<

>

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

Deletes all messages from the Queue.

Subscriptions

queues.subscriptions