Skip to content
Cloudflare API
Start here
API Reference
Queues

Messages

Push Message
client.queues.messages.push(stringqueueId, MessagePushParamsparams, RequestOptionsoptions?): MessagePushResponse { metadata }
POST/accounts/{account_id}/queues/{queue_id}/messages
Acknowledge + Retry Queue Messages
client.queues.messages.ack(stringqueueId, MessageAckParams { account_id, acks, retries } params, RequestOptionsoptions?): MessageAckResponse { ackCount, retryCount, warnings }
POST/accounts/{account_id}/queues/{queue_id}/messages/ack
Pull Queue Messages
client.queues.messages.pull(stringqueueId, MessagePullParams { account_id, batch_size, visibility_timeout_ms } params, RequestOptionsoptions?): MessagePullResponse { message_backlog_count, messages, metadata }
POST/accounts/{account_id}/queues/{queue_id}/messages/pull
Push Message Batch
client.queues.messages.bulkPush(stringqueueId, MessageBulkPushParams { account_id, delay_seconds, messages } params, RequestOptionsoptions?): MessageBulkPushResponse { metadata }
POST/accounts/{account_id}/queues/{queue_id}/messages/batch
ModelsExpand Collapse
MessagePushResponse { metadata }
metadata?: Metadata { metrics }
metrics?: Metrics { backlog_bytes, backlog_count, oldest_message_timestamp_ms }

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

backlog_bytes: number

The size in bytes of unacknowledged messages in the queue.

backlog_count: number

The number of unacknowledged messages in the queue.

oldest_message_timestamp_ms: number

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

MessageAckResponse { ackCount, retryCount, warnings }
ackCount?: number

The number of messages that were succesfully acknowledged.

retryCount?: number

The number of messages that were succesfully retried.

warnings?: Record<string, string>

Map of lease IDs to warning messages encountered during acknowledgement.

MessagePullResponse { message_backlog_count, messages, metadata }
message_backlog_count?: number

The number of unacknowledged messages in the queue.

messages?: Array<Message>
id?: string
attempts?: number
body?: string
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.

metadata?: unknown
timestamp_ms?: number
metadata?: Metadata { metrics }
metrics?: Metrics { backlog_bytes, backlog_count, oldest_message_timestamp_ms }

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

backlog_bytes: number

The size in bytes of unacknowledged messages in the queue.

backlog_count: number

The number of unacknowledged messages in the queue.

oldest_message_timestamp_ms: number

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

MessageBulkPushResponse { metadata }
metadata?: Metadata { metrics }
metrics?: Metrics { backlog_bytes, backlog_count, oldest_message_timestamp_ms }

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

backlog_bytes: number

The size in bytes of unacknowledged messages in the queue.

backlog_count: number

The number of unacknowledged messages in the queue.

oldest_message_timestamp_ms: number

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