Skip to content
Cloudflare API
Start here
API Reference
Queues

Consumers

List Queue Consumers
queues.consumers.list(strqueue_id, ConsumerListParams**kwargs) -> SyncSinglePage[Consumer]
GET/accounts/{account_id}/queues/{queue_id}/consumers
Get Queue Consumer
queues.consumers.get(strconsumer_id, ConsumerGetParams**kwargs) -> Consumer
GET/accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}
Create a Queue Consumer
queues.consumers.create(strqueue_id, ConsumerCreateParams**kwargs) -> Consumer
POST/accounts/{account_id}/queues/{queue_id}/consumers
Update Queue Consumer
queues.consumers.update(strconsumer_id, ConsumerUpdateParams**kwargs) -> Consumer
PUT/accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}
Delete Queue Consumer
queues.consumers.delete(strconsumer_id, ConsumerDeleteParams**kwargs) -> ConsumerDeleteResponse
DELETE/accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}
ModelsExpand Collapse
Consumer

Response body representing a consumer

One of the following:
class MqWorkerConsumerResponse: …
consumer_id: Optional[str]

A Resource identifier.

maxLength32
created_on: Optional[datetime]
formatdate-time
dead_letter_queue: Optional[str]

Name of the dead letter queue, or empty string if not configured

queue_name: Optional[str]
script_name: Optional[str]

Name of a Worker

settings: Optional[MqWorkerConsumerResponseSettings]
batch_size: Optional[float]

The maximum number of messages to include in a batch.

max_concurrency: Optional[float]

Maximum number of concurrent consumers that may consume from this Queue. Set to null to automatically opt in to the platform's maximum (recommended).

max_retries: Optional[float]

The maximum number of retries

max_wait_time_ms: Optional[float]

The number of milliseconds to wait for a batch to fill up before attempting to deliver it

retry_delay: Optional[float]

The number of seconds to delay before making the message available for another attempt.

type: Optional[Literal["worker"]]
class MqHTTPConsumerResponse: …
consumer_id: Optional[str]

A Resource identifier.

maxLength32
created_on: Optional[datetime]
formatdate-time
dead_letter_queue: Optional[str]

Name of the dead letter queue, or empty string if not configured

queue_name: Optional[str]
settings: Optional[MqHTTPConsumerResponseSettings]
batch_size: Optional[float]

The maximum number of messages to include in a batch.

max_retries: Optional[float]

The maximum number of retries

retry_delay: Optional[float]

The number of seconds to delay before making the message available for another attempt.

visibility_timeout_ms: Optional[float]

The number of milliseconds that a message is exclusively leased. After the timeout, the message becomes available for another attempt.

type: Optional[Literal["http_pull"]]
class ConsumerDeleteResponse: …
errors: Optional[List[ResponseInfo]]
minLength1
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[Source]
pointer: Optional[str]
messages: Optional[List[str]]
success: Optional[Literal[true]]

Indicates if the API call was successful or not.