List Queue Consumers

GET

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

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

Returns the consumers for a queue.

Request

Path Params

name

string

required

account_identifier

string

required

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200List Queue Consumers response

application/json

Body

allOf {5}

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

errors

null

optional

object

optional

messages

null

optional

object

optional

result_info

object

optional

object

optional

result

array[object (consumer) {5}]

optional

Example

{
    "errors": null,
    "messages": null,
    "result": [
        {
            "created_on": null,
            "environment": null,
            "queue_name": null,
            "service": null,
            "settings": {
                "batch_size": 10,
                "max_retries": 3,
                "max_wait_time_ms": 5000
            }
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 100,
        "total_count": 1,
        "total_pages": 1
    }
}

🟢200List Queue Consumers response failure

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

Update Queue

Create Queue Consumer