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 Messages API

Operations for sending, receiving, and acknowledging messages

Cloudflare Queues Messages 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 Message. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 6 paths, and defines 15 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.

6 operations 6 paths 15 schemas 6 POST

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 Messages 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 6

Across 6 paths, the API surfaces 6 operations — 6 POST. Each is listed below with its method, path, parameters, and response codes.

Messages 6

Operations for sending, receiving, and acknowledging messages

POST
/accounts/{account_id}/queues/{queue_id}/messages
Push Message
queues-push-message 2 params body → 4XX200
POST
/accounts/{account_id}/queues/{queue_id}/messages/ack
Acknowledge + Retry Queue Messages
queues-ack-messages 2 params body → 4XX200
POST
/accounts/{account_id}/queues/{queue_id}/messages/batch
Push Message Batch
queues-push-messages 2 params body → 4XX200
POST
/accounts/{account_id}/queues/{queue_id}/messages/preview
Preview Queue Messages
queues-preview-messages 2 params body → 4XX200
POST
/accounts/{account_id}/queues/{queue_id}/messages/preview/ack
Delete Previewed Queue Messages
queues-ack-preview-messages 2 params body → 4XX200
POST
/accounts/{account_id}/queues/{queue_id}/messages/pull
Pull Queue Messages
queues-pull-messages 2 params body → 4XX200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are mq_api-v4-success (3 properties), mq_api-v4-failure (3 properties), mq_queue-metrics (3 properties), mq_queue-message-json (2 properties). Each schema is shown below with its type and property counts.

mq_queue-message-json
object
2 properties
mq_queue-message-text
object
2 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_queue-batch
object
2 properties
mq_queue-message
mq_queue-pull-batch
array
mq_api-v4-success
object
3 properties
mq_identifier
string
A Resource identifier.
mq_api-v4-failure
object
3 properties
mq_retry-delay
number
The number of seconds to delay before making the message available for another attempt.
mq_batch-size
number
The maximum number of messages to include in a batch.
mq_api-v4-error
array
mq_queue-metrics
object
Best-effort metrics for the queue. Values may be approximate due to the distributed nature of queues.
3 properties 3 required
mq_api-v4-message
array
mq_lease-id
string
An ID that represents an "in-flight" message that has been pulled from a Queue. You must hold on to this ID and use it to acknowledge this message.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Cloudflare Queues publishes across the network.

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

This is an independent, third-party profile of Cloudflare Queues Messages 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.