Create Queue Consumer

POST

https://api.cloudflare.com/client/v4/accounts/{account_identifier}/workers/queues/{name}/consumers

Last modified:2022-12-16 13:48:34

Creates a new consumer for a queue.

Request

Path Params

name

string

required

account_identifier

string

required

Body Params application/json

optional

Example:

{"dead_letter_queue":"example-dlq","environment":"production","script_name":"example-consumer","settings":{"batch_size":10,"max_retries":3,"max_wait_time_ms":5000}}

Example

{
    "dead_letter_queue": "example-dlq",
    "environment": "production",
    "script_name": "example-consumer",
    "settings": {
        "batch_size": 10,
        "max_retries": 3,
        "max_wait_time_ms": 5000
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cloudflare.com/client/v4/accounts//workers/queues//consumers' \
--header 'Content-Type: application/json' \
--data-raw '{
    "dead_letter_queue": "example-dlq",
    "environment": "production",
    "script_name": "example-consumer",
    "settings": {
        "batch_size": 10,
        "max_retries": 3,
        "max_wait_time_ms": 5000
    }
}'

Responses

🟢200Create Queue Consumer response

application/json

Body

allOf {2}

optional

object (api-response-collection)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

object

optional

result

object | allOf {1}

optional

Example

🟢200Create Queue Consumer response failure

Modified at 2022-12-16 13:48:34

List Queue Consumers

Delete Queue Consumer