Delete Queue Consumer

queues.consumers.delete(, ) -> ConsumerDeleteResponse

DELETE/accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}

Deletes the consumer for a queue.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Queues WriteWorkers Scripts Write

ParametersExpand Collapse

account_id: str

A Resource identifier.

maxLength32

queue_id: str

A Resource identifier.

maxLength32

consumer_id: str

A Resource identifier.

maxLength32

ReturnsExpand Collapse

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.

Delete Queue Consumer

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
consumer = client.queues.consumers.delete(
    consumer_id="023e105f4ecef8ad9ca31a8372d0c353",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    queue_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(consumer.errors)

{
  "errors": [
    {
      "code": 7003,
      "message": "No route for the URI",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    "string"
  ],
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "code": 7003,
      "message": "No route for the URI",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    "string"
  ],
  "success": true
}