Skip to content
Cloudflare API
Start here
API Reference
Queues

Messages

Push Message
queues.messages.push(strqueue_id, MessagePushParams**kwargs) -> MessagePushResponse
POST/accounts/{account_id}/queues/{queue_id}/messages
Acknowledge + Retry Queue Messages
queues.messages.ack(strqueue_id, MessageAckParams**kwargs) -> MessageAckResponse
POST/accounts/{account_id}/queues/{queue_id}/messages/ack
Pull Queue Messages
queues.messages.pull(strqueue_id, MessagePullParams**kwargs) -> MessagePullResponse
POST/accounts/{account_id}/queues/{queue_id}/messages/pull
Push Message Batch
queues.messages.bulk_push(strqueue_id, MessageBulkPushParams**kwargs) -> MessageBulkPushResponse
POST/accounts/{account_id}/queues/{queue_id}/messages/batch
Peek Queue Messages
queues.messages.peek(strqueue_id, MessagePeekParams**kwargs) -> MessagePeekResponse
POST/accounts/{account_id}/queues/{queue_id}/messages/peek
Purge Peeked Queue Messages
queues.messages.purge(strqueue_id, MessagePurgeParams**kwargs) -> MessagePurgeResponse
POST/accounts/{account_id}/queues/{queue_id}/messages/purge
ModelsExpand Collapse
class MessagePushResponse: …
metadata: Optional[Metadata]
metrics: Optional[MetadataMetrics]

Best-effort metrics for the queue. Values may be approximate due to the distributed nature of queues.

backlog_bytes: float

The size in bytes of unacknowledged messages in the queue.

backlog_count: float

The number of unacknowledged messages in the queue.

oldest_message_timestamp_ms: float

Unix timestamp in milliseconds of the oldest unacknowledged message in the queue. Returns 0 if unknown.

class MessageAckResponse: …
ack_count: Optional[float]

The number of messages that were succesfully acknowledged.

retry_count: Optional[float]

The number of messages that were succesfully retried.

warnings: Optional[Dict[str, str]]

Map of lease IDs to warning messages encountered during acknowledgement.

class MessagePullResponse: …
message_backlog_count: Optional[float]

The number of unacknowledged messages in the queue.

messages: Optional[List[Message]]
id: Optional[str]
attempts: Optional[float]
body: Optional[str]
lease_id: Optional[str]

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.

metadata: Optional[object]
timestamp_ms: Optional[float]
metadata: Optional[Metadata]
metrics: Optional[MetadataMetrics]

Best-effort metrics for the queue. Values may be approximate due to the distributed nature of queues.

backlog_bytes: float

The size in bytes of unacknowledged messages in the queue.

backlog_count: float

The number of unacknowledged messages in the queue.

oldest_message_timestamp_ms: float

Unix timestamp in milliseconds of the oldest unacknowledged message in the queue. Returns 0 if unknown.

class MessageBulkPushResponse: …
metadata: Optional[Metadata]
metrics: Optional[MetadataMetrics]

Best-effort metrics for the queue. Values may be approximate due to the distributed nature of queues.

backlog_bytes: float

The size in bytes of unacknowledged messages in the queue.

backlog_count: float

The number of unacknowledged messages in the queue.

oldest_message_timestamp_ms: float

Unix timestamp in milliseconds of the oldest unacknowledged message in the queue. Returns 0 if unknown.

class MessagePeekResponse: …
messages: Optional[List[Message]]
id: Optional[str]
attempts: Optional[float]
body: Optional[str]
metadata: Optional[object]
ref: Optional[str]

An opaque reference to a peeked message. You must hold on to this value and use it to purge the message.

timestamp_ms: Optional[float]
class MessagePurgeResponse: …
errors: Optional[List[Error]]

Errors encountered while purging messages.

message: Optional[str]
warnings: Optional[Dict[str, str]]

Map of refs to warning messages encountered during purge.