How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cloudflare Queues Consumer API

Operations for managing queue consumers (Worker push or HTTP pull)

Cloudflare Queues Consumer API is one of 4 APIs that Cloudflare Queues publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Consumer. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.cloudflare.com/client/v4.

5 operations 2 paths 19 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.cloudflare.com/client/v4
Authentication
HTTP Bearer, API Key, API Key
Resource Areas
1

Authentication & Security 3

Cloudflare Queues Consumer API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (api_token). An API key is passed in the header as X-Auth-Email (api_email). An API key is passed in the header as X-Auth-Key (api_key). By default, every request must be authenticated.

  • api_token — Cloudflare API Token (Bearer)
  • api_email — Cloudflare account email address
  • api_key — Cloudflare Global API Key

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Consumer 5

Operations for managing queue consumers (Worker push or HTTP pull)

GET
/accounts/{account_id}/queues/{queue_id}/consumers
List Queue Consumers
queues-list-consumers 2 params → 4XX200
POST
/accounts/{account_id}/queues/{queue_id}/consumers
Create a Queue Consumer
queues-create-consumer 2 params body → 4XX200
DELETE
/accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}
Delete Queue Consumer
queues-delete-consumer 3 params → 4XX200
GET
/accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}
Get Queue Consumer
queues-get-consumer 3 params → 4XX200
PUT
/accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}
Update Queue Consumer
queues-update-consumer 3 params body → 4XX200

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are mq_worker-consumer-response (7 properties), mq_http-consumer-response (6 properties), mq_worker-consumer-request (4 properties), mq_http-consumer-request (3 properties). Each schema is shown below with its type and property counts.

mq_script-name
string
Name of a Worker
mq_consumer-request
object
Request body for creating or updating a consumer
mq_identifier
string
A Resource identifier.
mq_api-v4-success
object
3 properties
mq_max-concurrency
number
Maximum number of concurrent consumers that may consume from this Queue. Set to null to automatically opt in to the platform's maximum (recommended).
mq_retry-delay
number
The number of seconds to delay before making the message available for another attempt.
mq_max-retries
number
The maximum number of retries
mq_worker-consumer-response
object
7 properties
mq_visibility-timeout
number
The number of milliseconds that a message is exclusively leased. After the timeout, the message becomes available for another attempt.
mq_max-wait-time
number
The number of milliseconds to wait for a batch to fill up before attempting to deliver it
mq_queue-name
string
mq_worker-consumer-request
object
4 properties 2 required
mq_http-consumer-response
object
6 properties
mq_api-v4-failure
object
3 properties
mq_http-consumer-request
object
3 properties 1 required
mq_batch-size
number
The maximum number of messages to include in a batch.
mq_api-v4-error
array
mq_api-v4-message
array
mq_consumer-response
object
Response body representing a consumer

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cloudflare-queues-consumer-api-openapi.yml Raw ↑

Other APIs Cloudflare Queues publishes across the network.

Cloudflare Queues Messages API
Cloudflare Queues Metrics API
Cloudflare Queues Queue API
Where this information came from

This is an independent, third-party profile of Cloudflare Queues Consumer API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.