openapi: 3.2.0
info:
  description: Welcome to Cloudflare's API documentation site.
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  title: Cloudflare Queue API
  version: 4.0.0
servers:
- description: Client API
  url: https://api.cloudflare.com/client/v4
security:
- api_email: []
  api_key: []
- api_token: []
- user_service_key: []
tags:
- name: Queue
paths:
  /accounts/{account_id}/event_subscriptions/subscriptions:
    get:
      operationId: subscriptions-list
      summary: List Event Subscriptions
      description: Returns a paginated list of Queue event subscriptions with optional sorting and filtering.
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: page
        in: query
        description: Page number for pagination
        schema:
          type: integer
          default: 1
          minimum: 1
      - name: per_page
        in: query
        description: Number of items per page
        schema:
          type: integer
          default: 20
          maximum: 100
          minimum: 1
      - name: order
        in: query
        description: Field to sort by
        schema:
          type: string
          default: name
          enum:
          - created_at
          - name
          - enabled
          - source
      - name: direction
        in: query
        description: Sort direction
        schema:
          type: string
          default: asc
          enum:
          - asc
          - desc
      responses:
        '200':
          description: List of event subscriptions
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/mq_api-v4-success'
                - properties:
                    result:
                      type: array
                      items:
                        $ref: '#/components/schemas/mq_event-subscription'
                    result_info:
                      type: object
                      properties:
                        count:
                          description: Number of items in current page
                          type: integer
                        page:
                          description: Current page number
                          type: integer
                        per_page:
                          description: Items per page
                          type: integer
                        total_count:
                          description: Total number of items
                          type: integer
                        total_pages:
                          description: Total number of pages
                          type: integer
                      required:
                      - count
                      - total_count
                      - page
                      - per_page
                      - total_pages
                  type: object
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Queues Read
      - Workers Scripts Write
      - Workers Scripts Read
      x-fern-availability: generally-available
      x-fern-sdk-group-name: queues.subscriptions
      x-fern-sdk-method-name: list
    post:
      operationId: subscriptions-create
      summary: Create Event Subscription
      description: Creates an event subscription for a Queue.
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                destination:
                  $ref: '#/components/schemas/mq_event-destination'
                enabled:
                  description: Whether the subscription is active
                  type: boolean
                  x-auditable: true
                events:
                  description: List of event types this subscription handles
                  type: array
                  items:
                    type: string
                  minItems: 1
                  x-auditable: true
                name:
                  description: Name of the subscription
                  type: string
                  x-auditable: true
                source:
                  $ref: '#/components/schemas/mq_event-source'
      responses:
        '200':
          description: Successfully created event subscription
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/mq_api-v4-success'
                - properties:
                    result:
                      $ref: '#/components/schemas/mq_event-subscription'
                  type: object
        '400':
          description: Invalid request body or validation errors
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
        '404':
          description: Queue does not exist or resource not found on source
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
        '405':
          description: Multiple subscriptions on same resource not supported
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-fern-availability: generally-available
      x-fern-sdk-group-name: queues.subscriptions
      x-fern-sdk-method-name: create
  /accounts/{account_id}/event_subscriptions/subscriptions/{subscription_id}:
    delete:
      operationId: subscriptions-delete
      summary: Delete Event Subscription
      description: Deletes an existing Queue event subscription.
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: subscription_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      responses:
        '200':
          description: Successfully created event subscription
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/mq_api-v4-success'
                - properties:
                    result:
                      $ref: '#/components/schemas/mq_event-subscription'
                  type: object
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-fern-availability: generally-available
      x-fern-sdk-group-name: queues.subscriptions
      x-fern-sdk-method-name: delete
    get:
      operationId: subscriptions-get
      summary: Get Event Subscription
      description: Returns an existing Queue event subscription.
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: subscription_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      responses:
        '200':
          description: Details about an event subscription
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/mq_api-v4-success'
                - properties:
                    result:
                      $ref: '#/components/schemas/mq_event-subscription'
                  type: object
        '404':
          description: Event subscription does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-fern-availability: generally-available
      x-fern-sdk-group-name: queues.subscriptions
      x-fern-sdk-method-name: get
    patch:
      operationId: subscriptions-patch
      summary: Update Event Subscription
      description: Updates an existing Queue event subscription.
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: subscription_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                destination:
                  $ref: '#/components/schemas/mq_event-destination'
                enabled:
                  description: Whether the subscription is active
                  type: boolean
                  x-auditable: true
                events:
                  description: List of event types this subscription handles
                  type: array
                  items:
                    type: string
                  minItems: 1
                  x-auditable: true
                name:
                  description: Name of the subscription
                  type: string
                  x-auditable: true
      responses:
        '200':
          description: Successfully created event subscription
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/mq_api-v4-success'
                - properties:
                    result:
                      $ref: '#/components/schemas/mq_event-subscription'
                  type: object
        '400':
          description: Invalid request body or validation errors
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
        '404':
          description: Queue does not exist or resource not found on source
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-fern-availability: generally-available
      x-fern-sdk-group-name: queues.subscriptions
      x-fern-sdk-method-name: update
      x-forge-params:
        enabled:
          default: null
  /accounts/{account_id}/queues:
    get:
      operationId: queues-list
      summary: List Queues
      description: Returns the queues owned by an account.
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      responses:
        '200':
          description: List of all Queues that belong to this account
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/mq_api-v4-success'
                - properties:
                    result:
                      type: array
                      items:
                        $ref: '#/components/schemas/mq_queue'
                    result_info:
                      type: object
                      properties:
                        count:
                          description: Total number of queues
                          type: number
                          example: 1
                        page:
                          description: Current page within paginated list of queues
                          type: number
                          example: 1
                        per_page:
                          description: Number of queues per page
                          type: number
                          example: 20
                        total_count:
                          description: Total queues available without any search parameters
                          type: number
                          example: 2000
                        total_pages:
                          description: Total pages available without any search parameters
                          type: number
                          example: 100
                  type: object
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Queues Read
      - Workers Scripts Write
      - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.list
      x-fern-availability: generally-available
      x-fern-sdk-group-name: queues
      x-fern-sdk-method-name: list
    post:
      operationId: queues-create
      summary: Create Queue
      description: Creates a Queue in the account.
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                jurisdiction:
                  $ref: '#/components/schemas/mq_jurisdiction'
                queue_name:
                  $ref: '#/components/schemas/mq_queue-name'
              required:
              - queue_name
      responses:
        '200':
          description: Created Queue
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/mq_api-v4-success'
                - properties:
                    result:
                      $ref: '#/components/schemas/mq_queue'
                  type: object
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.create
      x-fern-availability: generally-available
      x-fern-sdk-group-name: queues
      x-fern-sdk-method-name: create
  /accounts/{account_id}/queues/{queue_id}:
    delete:
      operationId: queues-delete
      summary: Delete Queue
      description: Deletes a Queue.
      parameters:
      - name: queue_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      responses:
        '200':
          description: Successful delete
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-success'
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.delete
      x-fern-availability: generally-available
      x-fern-sdk-group-name: queues
      x-fern-sdk-method-name: delete
    get:
      operationId: queues-get
      summary: Get Queue
      description: Returns details about a specific Queue.
      parameters:
      - name: queue_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      responses:
        '200':
          description: Details of the requested Queue
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/mq_api-v4-success'
                - properties:
                    result:
                      $ref: '#/components/schemas/mq_queue'
                  type: object
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Queues Read
      - Workers Scripts Write
      - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.read
      x-fern-availability: generally-available
      x-fern-sdk-group-name: queues
      x-fern-sdk-method-name: get
    patch:
      operationId: queues-update-partial
      summary: Update Queue
      description: Updates part of a Queue's configuration.
      parameters:
      - name: queue_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mq_queue'
      responses:
        '200':
          description: Updated Queue
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/mq_api-v4-success'
                - properties:
                    result:
                      type: object
                      allOf:
                      - $ref: '#/components/schemas/mq_queue'
                  type: object
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.update
      x-fern-availability: generally-available
      x-fern-sdk-group-name: queues
      x-fern-sdk-method-name: edit
    put:
      operationId: queues-update
      summary: Update Queue
      description: Replaces a Queue's configuration with the supplied configuration. This endpoint does not support partial updates.
      parameters:
      - name: queue_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mq_queue'
      responses:
        '200':
          description: Updated Queue
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/mq_api-v4-success'
                - properties:
                    result:
                      type: object
                      allOf:
                      - $ref: '#/components/schemas/mq_queue'
                  type: object
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.update
      x-fern-availability: generally-available
      x-fern-ignore: true
      x-fern-sdk-group-name: queues
      x-fern-sdk-method-name: update
  /accounts/{account_id}/queues/{queue_id}/consumers:
    get:
      operationId: queues-list-consumers
      summary: List Queue Consumers
      description: Returns the consumers configured for a Queue.
      parameters:
      - name: queue_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      responses:
        '200':
          description: All consumers attached to this Queue
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/mq_api-v4-success'
                - properties:
                    result:
                      type: array
                      items:
                        $ref: '#/components/schemas/mq_consumer-response'
                  type: object
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Queues Read
      - Workers Scripts Write
      - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.list
      x-fern-availability: generally-available
      x-fern-sdk-group-name: queues.consumers
      x-fern-sdk-method-name: list
    post:
      operationId: queues-create-consumer
      summary: Create a Queue Consumer
      description: Creates a consumer for a Queue.
      parameters:
      - name: queue_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mq_consumer-request'
      responses:
        '200':
          description: Create Queue Consumer response.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/mq_api-v4-success'
                - properties:
                    result:
                      $ref: '#/components/schemas/mq_consumer-response'
                  type: object
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.create
      x-fern-availability: generally-available
      x-fern-sdk-group-name: queues.consumers
      x-fern-sdk-method-name: create
  /accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}:
    delete:
      operationId: queues-delete-consumer
      summary: Delete Queue Consumer
      description: Deletes a consumer from a Queue.
      parameters:
      - name: consumer_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: queue_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      responses:
        '200':
          description: Successful consumer delete
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-success'
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.delete
      x-fern-availability: generally-available
      x-fern-sdk-group-name: queues.consumers
      x-fern-sdk-method-name: delete
    get:
      operationId: queues-get-consumer
      summary: Get Queue Consumer
      description: Returns a Queue consumer by identifier.
      parameters:
      - name: consumer_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: queue_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      responses:
        '200':
          description: Get Queue Consumer response.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/mq_api-v4-success'
                - properties:
                    result:
                      $ref: '#/components/schemas/mq_consumer-response'
                  type: object
        4XX:
          description: Get Queue Consumer response failure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Queues Read
      - Workers Scripts Write
      - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.read
      x-fern-availability: generally-available
      x-fern-sdk-group-name: queues.consumers
      x-fern-sdk-method-name: get
    put:
      operationId: queues-update-consumer
      summary: Update Queue Consumer
      description: Replaces a Queue consumer, or creates it if it does not exist.
      parameters:
      - name: consumer_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: queue_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mq_consumer-request'
      responses:
        '200':
          description: Update Queue Consumer response.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/mq_api-v4-success'
                - properties:
                    result:
                      $ref: '#/components/schemas/mq_consumer-response'
                  type: object
        4XX:
          description: Update Queue Consumer response failure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.update
      x-fern-availability: generally-available
      x-fern-sdk-group-name: queues.consumers
      x-fern-sdk-method-name: update
  /accounts/{account_id}/queues/{queue_id}/messages:
    post:
      operationId: queues-push-message
      summary: Push Message
      description: Pushes a message to a Queue.
      parameters:
      - name: queue_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mq_queue-message'
      responses:
        '200':
          description: Successful message ingestion.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/mq_api-v4-success'
                - properties:
                    result:
                      type: object
                      properties:
                        metadata:
                          type: object
                          properties:
                            metrics:
                              $ref: '#/components/schemas/mq_queue-metrics'
                  type: object
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-auditable: false
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.push
      x-fern-availability: generally-available
      x-fern-sdk-group-name: queues.messages
      x-fern-sdk-method-name: push
  /accounts/{account_id}/queues/{queue_id}/messages/ack:
    post:
      operationId: queues-ack-messages
      summary: Acknowledge + Retry Queue Messages
      description: Acknowledges successfully processed Queue messages and retries messages that were not processed successfully.
      parameters:
      - name: queue_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                acks:
                  type: array
                  items:
                    properties:
                      lease_id:
                        $ref: '#/components/schemas/mq_lease-id'
                    type: object
                retries:
                  type: array
                  items:
                    properties:
                      delay_seconds:
                        $ref: '#/components/schemas/mq_retry-delay'
                      lease_id:
                        $ref: '#/components/schemas/mq_lease-id'
                    type: object
      responses:
        '200':
          description: Details of ACKs and retries
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/mq_api-v4-success'
                - properties:
                    result:
                      type: object
                      properties:
                        ackCount:
                          description: The number of messages that were succesfully acknowledged.
                          type: number
                          example: 5
                        retryCount:
                          description: The number of messages that were succesfully retried.
                          type: number
                          example: 5
                        warnings:
                          description: Map of lease IDs to warning messages encountered during acknowledgement.
                          type: object
                          additionalProperties:
                            type: string
                  type: object
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-auditable: false
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.ack
      x-fern-availability: generally-available
      x-fern-sdk-group-name: queues.messages
      x-fern-sdk-method-name: ack
  /accounts/{account_id}/queues/{queue_id}/messages/batch:
    post:
      operationId: queues-push-messages
      summary: Push Message Batch
      description: Pushes a batch of messages to a Queue.
      parameters:
      - name: queue_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mq_queue-batch'
      responses:
        '200':
          description: Successful batch ingestion.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/mq_api-v4-success'
                - properties:
                    result:
                      type: object
                      properties:
                        metadata:
                          type: object
                          properties:
                            metrics:
                              $ref: '#/components/schemas/mq_queue-metrics'
                  type: object
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-auditable: false
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.push
      x-fern-availability: generally-available
      x-fern-sdk-group-name: queues.messages
      x-fern-sdk-method-name: bulk-push
  /accounts/{account_id}/queues/{queue_id}/messages/extend:
    post:
      operationId: queues-extend-messages
      summary: Extend Message Leases
      description: Extends message leases without incrementing the messages' `attempts` counters. Each message receives a new lease identifier.
      parameters:
      - name: queue_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                extend:
                  type: array
                  items:
                    properties:
                      lease_id:
                        $ref: '#/components/schemas/mq_lease-id'
                    type: object
                visibility_timeout_ms:
                  $ref: '#/components/schemas/mq_visibility-timeout'
      responses:
        '200':
          description: New lease IDs
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/mq_api-v4-success'
                - properties:
                    result:
                      type: object
                      properties:
                        extendCount:
                          description: The number of message leases that were succesfully extended.
                          type: number
                          example: 5
                        warnings:
                          description: Map of lease IDs to warning messages encountered during extensions.
                          type: object
                          additionalProperties:
                            type: string
                  type: object
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-auditable: false
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.pull
      x-fern-availability: generally-available
      x-fern-sdk-group-name: queues.messages
      x-fern-sdk-method-name: extend-leases
  /accounts/{account_id}/queues/{queue_id}/messages/peek:
    post:
      operationId: queues-peek-messages
      summary: Peek Queue Messages
      description: Peek messages from a Queue without leasing them. Each message includes a ref that can be passed to the purge endpoint, and remains available for subsequent peek or pull operations until it is purged.
      parameters:
      - name: queue_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                batch_size:
                  $ref: '#/components/schemas/mq_batch-size'
      responses:
        '200':
          description: A batch of peeked messages from the Queue
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/mq_api-v4-success'
                - properties:
                    result:
                      type: object
                      properties:
                        messages:
                          $ref: '#/components/schemas/mq_queue-peek-batch'
                  type: object
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-auditable: false
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.peek
      x-fern-availability: generally-available
      x-fern-sdk-group-name: queues.messages
      x-fern-sdk-method-name: peek
  /accounts/{account_id}/queues/{queue_id}/messages/preview:
    post:
      operationId: queues-preview-messages
      summary: Preview Queue Messages
      description: Preview messages from a Queue without leasing them. This deprecated route is retained for compatibility; use the peek endpoint for new integrations.
      parameters:
      - name: queue_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                batch_size:
                  $ref: '#/components/schemas/mq_batch-size'
      responses:
        '200':
          description: A batch of previewed messages from the Queue
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/mq_api-v4-success'
                - properties:
                    result:
                      type: object
                      properties:
                        messages:
                          $ref: '#/components/schemas/mq_queue-pull-batch'
                  type: object
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      deprecated: true
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Queues Read
      - Workers Scripts Write
      - Workers Scripts Read
      x-auditable: false
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.peek
      x-fern-availability: generally-available
      x-fern-ignore: true
      x-fern-sdk-group-name: queues.messages
      x-fern-sdk-method-name: preview
  /accounts/{account_id}/queues/{queue_id}/messages/preview/ack:
    post:
      operationId: queues-ack-preview-messages
      summary: Delete Previewed Queue Messages
      description: Delete messages returned by the legacy preview endpoint. This deprecated route is retained for compatibility; use the peek and purge endpoints for new integrations. Deleting messages this way does not count as delivery and does not affect metrics.
      parameters:
      - name: queue_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                acks:
                  type: array
                  items:
                    properties:
                      lease_id:
                        $ref: '#/components/schemas/mq_lease-id'
                    type: object
                retries:
                  type: array
                  items:
                    properties:
                      delay_seconds:
                        $ref: '#/components/schemas/mq_retry-delay'
                      lease_id:
                        $ref: '#/components/schemas/mq_lease-id'
                    type: object
      responses:
        '200':
          description: Result of acknowledging previewed messages
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/mq_api-v4-success'
                - properties:
                    result:
                      type: object
                      properties:
                        warnings:
                          description: Map of lease IDs to warning messages encountered during acknowledgement.
                          type: object
                          additionalProperties:
                            type: string
                  type: object
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      deprecated: true
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-auditable: false
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.ack
      x-fern-availability: generally-available
      x-fern-ignore: true
      x-fern-sdk-group-name: queues.messages
      x-fern-sdk-method-name: ack-preview
  /accounts/{account_id}/queues/{queue_id}/messages/pull:
    post:
      operationId: queues-pull-messages
      summary: Pull Queue Messages
      description: Pulls a batch of messages from a Queue for an HTTP pull consumer.
      parameters:
      - name: queue_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                batch_size:
                  $ref: '#/components/schemas/mq_batch-size'
                visibility_timeout_ms:
                  $ref: '#/components/schemas/mq_visibility-timeout'
      responses:
        '200':
          description: A batch of messages in the Queue
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/mq_api-v4-success'
                - properties:
                    result:
                      type: object
                      properties:
                        message_backlog_count:
                          description: The number of unacknowledged messages in the queue.
                          type: number
                          example: 5
                        messages:
                          $ref: '#/components/schemas/mq_queue-pull-batch'
                        metadata:
                          type: object
                          properties:
                            metrics:
                              $ref: '#/components/schemas/mq_queue-metrics'
                  type: object
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-auditable: false
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.pull
      x-fern-availability: generally-available
      x-fern-sdk-group-name: queues.messages
      x-fern-sdk-method-name: pull
  /accounts/{account_id}/queues/{queue_id}/messages/purge:
    post:
      operationId: queues-purge-messages
      summary: Purge Peeked Queue Messages
      description: Delete messages from a Queue by using refs returned by the peek endpoint. Purging messages does not count as delivery and does not affect metrics.
      parameters:
      - name: queue_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                refs:
                  type: array
                  items:
                    properties:
                      ref:
                        $ref: '#/components/schemas/mq_ref'
                    required:
                    - ref
                    type: object
              required:
              - refs
      responses:
        '200':
          description: Result of purging peeked messages
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/mq_api-v4-success'
                - properties:
                    result:
                      type: object
                      properties:
                        errors:
                          description: Errors encountered while purging messages.
                          type: array
                          items:
                            properties:
                              message:
                                type: string
                            type: object
                        warnings:
                          description: Map of refs to warning messages encountered during purge.
                          type: object
                          additionalProperties:
                            type: string
                  type: object
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-auditable: false
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.ack
      x-fern-availability: generally-available
      x-fern-sdk-group-name: queues.messages
      x-fern-sdk-method-name: purge
      x-forge-require-confirmation: This operation permanently deletes the selected messages from the Queue.
  /accounts/{account_id}/queues/{queue_id}/metrics:
    get:
      operationId: queues-get-metrics
      summary: Get Queue Metrics
      description: Returns best-effort metrics for a Queue. Values may be approximate due to the distributed nature of Queues.
      parameters:
      - name: queue_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      responses:
        '200':
          description: Queue metrics.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/mq_api-v4-success'
                - properties:
                    result:
                      $ref: '#/components/schemas/mq_queue-metrics'
                  type: object
            text/event-stream:
              schema:
                $ref: '#/components/schemas/mq_queue-metrics'
        4XX:
          description: Failure response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Queues Read
      - Workers Scripts Write
      - Workers Scripts Read
      x-fern-availability: generally-available
      x-fern-sdk-group-name: queues.metrics
      x-fern-sdk-method-name: get
  /accounts/{account_id}/queues/{queue_id}/purge:
    get:
      operationId: queues-purge-get
      summary: Get Queue Purge Status
      description: Returns the status of a Queue purge operation.
      parameters:
      - name: queue_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      responses:
        '200':
          description: Details of the requested Queue
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/mq_api-v4-success'
                - properties:
                    result:
                      type: object
                      properties:
                        completed:
                          description: Indicates if the last purge operation completed successfully.
                          type: string
                          readOnly: true
                          x-auditable: true
                        started_at:
                          description: Timestamp when the last purge operation started.
                          type: string
                          readOnly: true
                          x-auditable: true
                  type: object
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Queues Read
      - Workers Scripts Write
      - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.read
      x-fern-availability: generally-available
      x-fern-sdk-group-name: queues.purge
      x-fern-sdk-method-name: status
    post:
      operationId: queues-purge
      summary: Purge Queue
      description: Starts a purge that deletes all messages from a Queue.
      parameters:
      - name: queue_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                delete_messages_permanently:
                  description: Confirms that all messages will be permanently deleted.
                  type: boolean
                  example: true
                  x-auditable: true
      responses:
        '200':
          description: Updated Queue
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/mq_api-v4-success'
                - properties:
                    result:
                      type: object
                      allOf:
                      - $ref: '#/components/schemas/mq_queue'
                  type: object
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-v4-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.ack
      x-fern-availability: generally-available
      x-fern-sdk-group-name: queues.purge
      x-fern-sdk-method-name: start
      x-forge-require-confirmation: This operation drops every message in the queue.
components:
  schemas:
    mq_event-source-kv:
      type: object
      properties:
        type:
          description: Type of source
          type: string
          enum:
          - kv
          x-auditable: true
    mq_queue:
      type: object
      properties:
        consumers:
          type: array
          items:
            $ref: '#/components/schemas/mq_consumer-response'
          readOnly: true
        consumers_total_count:
          type: number
          readOnly: true
        created_on:
          type: string
          readOnly: true
          x-auditable: true
        jurisdiction:
          $ref: '#/components/schemas/mq_jurisdiction'
        modified_on:
          type: string
          readOnly: true
          x-auditable: true
        producers:
          type: array
          items:
            $ref: '#/components/schemas/mq_producer'
          readOnly: true
        producers_total_count:
          type: number
          readOnly: true
          x-auditable: true
        queue_id:
          type: string
          readOnly: true
          x-auditable: true
        queue_name:
          $ref: '#/components/schemas/mq_queue-name'
        settings:
          $ref: '#/components/schemas/mq_queue-settings'
    mq_queue-peek-batch:
      type: array
      items:
        properties:
          attempts:
            type: number
            example: 1
            readOnly: true
            x-auditable: true
          body:
            type: string
            example: hello world
            readOnly: true
          id:
            type: string
            example: b01b5594f784d0165c2985833f5660dd
            readOnly: true
            x-auditable: true
          metadata:
            type: object
            example:
              CF-Content-Type: text
              CF-sourceMessageSource: dash
            readOnly: true
          ref:
            $ref: '#/components/schemas/mq_ref'
          timestamp_ms:
            type: number
            example: 1710950954154
            readOnly: true
            x-auditable: true
        type: object
    mq_event-source-workflows-workflow:
      type: object
      properties:
        type:
          description: Type of source
          type: string
          enum:
          - workflows.workflow
          x-auditable: true
        workflow_name:
          description: Name of the workflow
          type: string
          x-auditable: true
    mq_batch-size:
      description: The maximum number of messages to include in a batch.
      type: number
      example: 50
      x-auditable: true
    mq_max-wait-time:
      description: The number of milliseconds to wait for a batch to fill up before attempting to deliver it
      type: number
      example: 5000
      x-auditable: true
    mq_queue-message-text:
      type: object
      properties:
        body:
          type: string
        content_type:
          type: string
          enum:
          - text
          x-auditable: true
    mq_event-source-vectorize:
      type: object
      properties:
        type:
          description: Type of source
          type: string
          enum:
          - vectorize
          x-auditable: true
    mq_visibility-timeout:
      description: The number of milliseconds that a message is exclusively leased. After the timeout, the message becomes available for another attempt.
      type: number
      example: 6000
      x-auditable: true
    mq_lease-id:
      description: 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.
      type: string
      example: eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIn0..Q8p21d7dceR6vUfwftONdQ.JVqZgAS-Zk7MqmqccYtTHeeMElNHaOMigeWdb8LyMOg.T2_HV99CYzGaQuhTyW8RsgbnpTRZHRM6N7UoSaAKeK0
      x-auditable: true
    mq_api-v4-failure:
      type: object
      properties:
        errors:
          $ref: '#/components/schemas/mq_api-v4-error'
        messages:
          $ref: '#/components/schemas/mq_api-v4-message'
        success:
          description: Indicates if the API call was successful or not.
          type: boolean
          example: false
          enum:
          - false
          x-auditable: true
    mq_queue-metrics:
      description: Best-effort metrics for the queue. Values may be approximate due to the distributed nature of queues.
      type: object
      properties:
        backlog_bytes:
          description: The size in bytes of unacknowledged messages in the queue.
          type: number
          example: 1024
          x-auditable: true
        backlog_count:
          description: The number of unacknowledged messages in the queue.
          type: number
          example: 5
          x-auditable: true
        oldest_message_timestamp_ms:
          description: Unix timestamp in milliseconds of the oldest unacknowledged message in the queue. Returns 0 if unknown.
          type: number
          example: 1710950954154
          x-auditable: true
      required:
      - backlog_count
      - backlog_bytes
      - oldest_message_timestamp_ms
    mq_worker-consumer-response:
      type: object
      properties:
        consumer_id:
          $ref: '#/components/schemas/mq_identifier'
        created_on:
          type: string
          format: date-time
          x-auditable: true
        dead_letter_queue:
          description: Name of the dead letter queue, or empty string if not configured
          type: string
          x-auditable: true
        queue_name:
          $ref: '#/components/schemas/mq_queue-name'
        script_name:
          $ref: '#/components/schemas/mq_script-name'
        settings:
          type: object
          properties:
            batch_size:
              $ref: '#/components/schemas/mq_batch-size'
            max_concurrency:
              $ref: '#/components/schemas/mq_max-concurrency'
            max_retries:
              $ref: '#/components/schemas/mq_max-retries'
            max_wait_time_ms:
              $ref: '#/components/schemas/mq_max-wait-time'
            retry_delay:
              $ref: '#/components/schemas/mq_retry-delay'
        type:
          type: string
          enum:
          - worker
          x-auditable: true
    mq_event-source-super-slurper:
      type: object
      properties:
        type:
          description: Type of source
          type: string
          enum:
          - superSlurper
          x-auditable: true
    mq_queue-settings:
      type: object
      properties:
        delivery_delay:
          description: Number of seconds to delay delivery of all messages to consumers.
          type: number
          example: 5
          x-auditable: true
        delivery_paused:
          description: Indicates if message delivery to consumers is currently paused.
          type: boolean
          example: true
          x-auditable: true
        message_retention_period:
          description: Number of seconds after which an unconsumed message will be delayed.
          type: number
          example: 345600
          x-auditable: true
    mq_http-consumer-response:
      type: object
      properties:
        consumer_id:
          $ref: '#/components/schemas/mq_identifier'
        created_on:
          type: string
          format: date-time
          x-auditable: true
        dead_letter_queue:
          description: Name of the dead letter queue, or empty string if not configured
          type: string
          x-auditable: true
        queue_name:
          $ref: '#/components/schemas/mq_queue-name'
        settings:
          type: object
          properties:
            batch_size:
              $ref: '#/components/schemas/mq_batch-size'
            max_retries:
              $ref: '#/components/schemas/mq_max-retries'
            retry_delay:
              $ref: '#/components/schemas/mq_retry-delay'
            visibility_timeout_ms:
              $ref: '#/components/schemas/mq_visibility-timeout'
        type:
          type: string
          enum:
          - http_pull
          x-auditable: true
    mq_event-source-workers-script:
      type: object
      properties:
        script_tag:
          description: Tag of the Worker script
          type: string
          x-auditable: true
        type:
          description: Type of source
          type: string
          enum:
          - workers.script
          x-auditable: true
    mq_queue-batch:
      type: object
      properties:
        delay_seconds:
          description: The number of seconds to wait for attempting to deliver this batch to consumers
          type: number
          example: text
          x-auditable: true
        messages:
          type: array
          items:
            $ref: '#/components/schemas/mq_queue-message'
    mq_api-v4-success:
      type: object
      properties:
        errors:
          $ref: '#/components/schemas/mq_api-v4-error'
        messages:
          $ref: '#/components/schemas/mq_api-v4-message'
        success:
          description: Indicates if the API call was successful or not.
          type: boolean
          enum:
          - true
          x-auditable: true
    mq_retry-delay:
      description: The number of seconds to delay before making the message available for another attempt.
      type: number
      example: 10
      x-auditable: true
    mq_queue-message-json:
      type: object
      properties:
        body:
          type: object
        content_type:
          type: string
          enum:
          - json
          x-auditable: true
    mq_event-subscription:
      type: object
      properties:
        created_at:
          description: When the subscription was created
          type: string
          format: date-time
          x-auditable: true
        destination:
          $ref: '#/components/schemas/mq_event-destination'
        enabled:
          description: Whether the subscription is active
          type: boolean
          x-auditable: true
        events:
          description: List of event types this subscription handles
          type: array
          items:
            type: string
          minItems: 1
          x-auditable: true
        id:
          description: Unique identifier for the subscription
          type: string
          x-auditable: true
        modified_at:
          description: When the subscription was last modified
          type: string
          format: date-time
          x-auditable: true
        name:
          description: Name of the subscription
          type: string
          x-auditable: true
        source:
          $ref: '#/components/schemas/mq_event-source'
      required:
      - id
      - created_at
      - modified_at
      - name
      - enabled
      - source
      - destination
      - events
    mq_producer:
      type: object
      oneOf:
      - $ref: '#/components/schemas/mq_worker-producer'
      - $ref: '#/components/schemas/mq_r2-producer'
    mq_event-source:
      description: Source configuration for the subscription
      type: object
      oneOf:
      - $ref: '#/components/schemas/mq_event-source-images'
      - $ref: '#/components/schemas/mq_event-source-kv'
      - $ref: '#/components/schemas/mq_event-source-r2'
      - $ref: '#/components/schemas/mq_event-source-super-slurper'
      - $ref: '#/components/schemas/mq_event-source-vectorize'
      - $ref: '#/components/schemas/mq_event-source-workers-ai-model'
      - $ref: '#/components/schemas/mq_event-source-workers-builds-worker'
      - $ref: '#/components/schemas/mq_event-source-workers-script'
      - $ref: '#/components/schemas/mq_event-source-workflows-workflow'
    mq_queue-pull-batch:
      type: array
      items:
        properties:
          attempts:
            type: number
            example: 1
            readOnly: true
            x-auditable: true
          body:
            type: string
            example: hello world
            readOnly: true
          id:
            type: string
            example: b01b5594f784d0165c2985833f5660dd
            readOnly: true
            x-auditable: true
          lease_id:
            $ref: '#/components/schemas/mq_lease-id'
          metadata:
            type: object
            example:
              CF-Content-Type: text
              CF-sourceMessageSource: dash
            readOnly: true
          timestamp_ms:
            type: number
            example: 1710950954154
            readOnly: true
            x-auditable: true
        type: object
    mq_event-destination-queue:
      type: object
      properties:
        queue_id:
          description: ID of the target queue
          type: string
          x-auditable: true
        type:
          description: Type of destination
          type: string
          enum:
          - queues.queue
          x-auditable: true
      required:
      - type
      - queue_id
    mq_event-source-images:
      type: object
      properties:
        type:
          description: Type of source
          type: string
          enum:
          - images
          x-auditable: true
    mq_jurisdiction:
      type: string
      example: eu
      enum:
      - eu
      - us
      - fedramp
      x-auditable: true
    mq_ref:
      description: An opaque reference to a peeked message. You must hold on to this value and use it to purge the message.
      type: string
      example: eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIn0..Q8p21d7dceR6vUfwftONdQ.JVqZgAS-Zk7MqmqccYtTHeeMElNHaOMigeWdb8LyMOg.T2_HV99CYzGaQuhTyW8RsgbnpTRZHRM6N7UoSaAKeK0
      x-auditable: true
    mq_event-source-workers-ai-model:
      type: object
      properties:
        model_name:
          description: Name of the Workers AI model
          type: string
          x-auditable: true
        type:
          description: Type of source
          type: string
          enum:
          - workersAi.model
          x-auditable: true
    mq_script-name:
      description: Name of a Worker
      type: string
      example: my-consumer-worker
      x-auditable: true
    mq_r2-producer:
      type: object
      properties:
        bucket_name:
          type: string
          x-auditable: true
        type:
          type: string
          enum:
          - r2_bucket
          x-auditable: true
    mq_max-concurrency:
      description: Maximum number of concurrent consumers that may consume from this Queue. Set to `null` to automatically opt in to the platform's maximum (recommended).
      type: number
      example: 10
      x-auditable: true
    mq_worker-producer:
      type: object
      properties:
        script:
          type: string
          x-auditable: true
        type:
          type: string
          enum:
          - worker
          x-auditable: true
    mq_identifier:
      description: A Resource identifier.
      type: string
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      x-auditable: true
    mq_consumer-request:
      description: Request body for creating or updating a consumer
      type: object
      discriminator:
        mapping:
          http_pull: '#/components/schemas/mq_http-consumer-request'
          worker: '#/components/schemas/mq_worker-consumer-request'
        propertyName: type
      oneOf:
      - $ref: '#/components/schemas/mq_worker-consumer-request'
      - $ref: '#/components/schemas/mq_http-consumer-request'
    mq_max-retries:
      description: The maximum number of retries
      type: number
      example: 3
      x-auditable: true
    mq_event-source-workers-builds-worker:
      type: object
      properties:
        type:
          description: Type of source
          type: string
          enum:
          - workersBuilds.worker
          x-auditable: true
        worker_name:
          description: Name of the worker
          type: string
          x-auditable: true
    mq_api-v4-message:
      type: array
      items:
        type: string
        x-auditable: true
      example: []
    mq_consumer-response:
      description: Response body representing a consumer
      type: object
      discriminator:
        mapping:
          http_pull: '#/components/schemas/mq_http-consumer-response'
          worker: '#/components/schemas/mq_worker-consumer-response'
        propertyName: type
      oneOf:
      - $ref: '#/components/schemas/mq_worker-consumer-response'
      - $ref: '#/components/schemas/mq_http-consumer-response'
    mq_worker-consumer-request:
      type: object
      properties:
        dead_letter_queue:
          $ref: '#/components/schemas/mq_queue-name'
        script_name:
          $ref: '#/components/schemas/mq_script-name'
        settings:
          type: object
          properties:
            batch_size:
              $ref: '#/components/schemas/mq_batch-size'
            max_concurrency:
              $ref: '#/components/schemas/mq_max-concurrency'
            max_retries:
              $ref: '#/components/schemas/mq_max-retries'
            max_wait_time_ms:
              $ref: '#/components/schemas/mq_max-wait-time'
            retry_delay:
              $ref: '#/components/schemas/mq_retry-delay'
        type:
          type: string
          enum:
          - worker
          x-auditable: true
      required:
      - type
      - script_name
    mq_event-destination:
      description: Destination configuration for the subscription
      type: object
      oneOf:
      - $ref: '#/components/schemas/mq_event-destination-queue'
    mq_queue-name:
      type: string
      example: example-queue
      x-auditable: true
    mq_event-source-r2:
      type: object
      properties:
        type:
          description: Type of source
          type: string
          enum:
          - r2
          x-auditable: true
    mq_queue-message:
      allOf:
      - properties:
          delay_seconds:
            description: The number of seconds to wait for attempting to deliver this message to consumers
            type: number
            example: text
            x-auditable: true
        type: object
      - oneOf:
        - $ref: '#/components/schemas/mq_queue-message-text'
        - $ref: '#/components/schemas/mq_queue-message-json'
    mq_api-v4-error:
      type: array
      items:
        properties:
          code:
            type: integer
            minimum: 1000
            x-auditable: true
          message:
            type: string
            x-auditable: true
        required:
        - code
        - message
        type: object
        uniqueItems: true
      example:
      - code: 7003
        message: No route for the URI
      minLength: 1
    mq_http-consumer-request:
      type: object
      properties:
        dead_letter_queue:
          $ref: '#/components/schemas/mq_queue-name'
        settings:
          type: object
          properties:
            batch_size:
              $ref: '#/components/schemas/mq_batch-size'
            max_retries:
              $ref: '#/components/schemas/mq_max-retries'
            retry_delay:
              $ref: '#/components/schemas/mq_retry-delay'
            visibility_timeout_ms:
              $ref: '#/components/schemas/mq_visibility-timeout'
        type:
          type: string
          enum:
          - http_pull
          x-auditable: true
      required:
      - type
  securitySchemes:
    api_email:
      in: header
      name: X-Auth-Email
      type: apiKey
    api_key:
      in: header
      name: X-Auth-Key
      type: apiKey
    api_token:
      scheme: bearer
      type: http
    user_service_key:
      in: header
      name: X-Auth-User-Service-Key
      type: apiKey
externalDocs:
  description: Cloudflare Radar Documentation
  url: https://developers.cloudflare.com/radar/
x-forge-commands:
  abuse-reports:
    description: Submit and track abuse reports for phishing, malware, and other policy violations on Cloudflare-proxied sites
    groups:
      appeals:
        description: Appeal eligibility for abuse reports
      emails:
        description: Emails sent for abuse reports
      mitigations:
        description: Mitigation actions taken in response to abuse reports
  accounts:
    description: Account settings, members, roles, subscriptions, and API tokens for your Cloudflare account
    groups:
      applications:
        description: Applications operations
      categories:
        description: Categories operations
      organizations:
        description: Move accounts between organizations
      profile:
        description: View and manage the profile for a Cloudflare account
      roles:
        description: View the roles available for assigning to account members, each defining a set of permissions
      subscriptions:
        description: View and manage plan subscriptions attached to this account
      tokens:
        description: Create and manage scoped API tokens for programmatic access to the Cloudflare API
  ai-gateway:
    description: Proxy, cache, rate-limit, and observe requests to AI providers — OpenAI, Anthropic, Workers AI, and more
    groups:
      custom-domains:
        description: Manage custom hostnames that route requests through an AI Gateway
      custom-providers:
        description: Manage account-level custom AI providers and their endpoint settings
      datasets:
        description: 'Deprecated: manage filtered collections of gateway logs used by evaluations'
      dynamic-routing:
        description: Route requests across multiple AI providers with fallback, load-balancing, and versioned deployments
      dynamic-routing.deployments:
        description: Deploy dynamic route versions and view deployment history
      dynamic-routing.versions:
        description: Create and inspect saved versions of a dynamic route
      evaluation-types:
        description: 'Deprecated: list the evaluator types that evaluations can use'
      evaluations:
        description: 'Deprecated: score the logs in a dataset with selected evaluator types'
      gateways:
        description: Create and configure AI Gateways for an account
      gateways.providers:
        description: Store and rotate upstream AI provider keys for a gateway
      logs:
        description: Inspect, annotate, and delete gateway request logs stored by Legacy Logs
  ai-search:
    description: 'Managed search-as-a-service: crawl, index, and query content with AI-powered relevance and chat completions'
    groups:
      items:
        description: Content indexed by AI Search instances
      jobs:
        description: Indexing job lifecycle for AI Search instances
      namespace:
        description: Logical groupings for organizing AI Search instances
      tokens:
        description: Credentials used by AI Search instances
  ai-security:
    description: Detect prompt injection, PII, and unsafe topics in traffic to your AI applications
    groups:
      custom-topics:
        description: Organization-specific topic categories used by AI Security for Apps content detection
  analytics:
    description: Zone-level traffic analytics — dashboard summaries, per-colo breakdowns, and Argo latency metrics
    groups:
      colo:
        description: Per-data-center (colo) traffic analytics breakdown for the zone
      dashboard:
        description: Aggregated zone dashboard analytics — requests, bandwidth, threats, and page views
      latency:
        description: Argo Smart Routing latency analytics showing time-to-first-byte improvements
  argo:
    description: Network optimization features that speed up and improve reliability of traffic to your origins
    groups:
      smart-routing:
        description: Route traffic through the fastest network paths to your origin using real-time latency data
      tiered-caching:
        description: Reduce origin load by having upper-tier data centers serve cache misses before reaching your origin
  basin-catalog:
    description: Iceberg-compatible data catalog for R2 — organize objects into tables and namespaces for SQL query engines
    groups:
      credentials:
        description: Catalog access credentials for external query engines (Spark, Trino, etc.)
      maintenance-configs:
        description: Table maintenance settings — compaction schedules and snapshot expiration policies
      namespaces:
        description: Logical namespaces that group related tables within the data catalog
      namespaces.tables:
        description: Tables within catalog namespaces
      namespaces.tables.maintenance-configs:
        description: Table-level maintenance configurations and operations
      namespaces.tables.maintenance-runs:
        description: History of maintenance runs performed on tables
  billing:
    description: Account billing profiles and usage data for Cloudflare subscriptions and add-on services
    groups:
      profiles:
        description: Billing profile with payment method, address, and invoice preferences
      usage:
        description: Metered usage data for billed services — requests, bandwidth, and feature consumption
  botnet-feed:
    description: Botnet threat intelligence feeds — IP and ASN-level data on known command-and-control infrastructure
    groups:
      asn:
        description: ASN-level botnet activity data showing networks with known C2 infrastructure
      configs:
        description: Botnet feed subscription configuration and notification preferences
  builds:
    description: Build and deploy Workers from connected repositories, then inspect build status and logs.
    groups:
      deploy-hooks:
        description: Manage branch-specific HTTP hooks that start builds.
      limits:
        description: View build-minute availability and refresh information.
      logs:
        description: Retrieve build logs.
      repos:
        description: Manage source repository connections for Workers Builds.
      tokens:
        description: Manage credentials used by Workers Builds to deploy Workers.
      triggers:
        description: Configure how repository changes build and deploy Workers.
      versions:
        description: Find builds associated with Worker versions.
      workers:
        description: Manage repository-backed build configuration for Workers.
  cache:
    description: Purge cached content and configure Cache Reserve, tiered caching, and variant serving
    groups:
      origin-cloud-regions:
        description: Manage Origin Cloud Regions routing and failover configurations
      settings:
        description: Configure Cache Reserve, tiered caching, and variant serving
      settings.regional-tiered-cache:
        description: Restrict tiered cache topology to data centers within a specific geographic region
      settings.reserve:
        description: Persistent storage tier that keeps cached assets even after eviction from edge caches
      settings.smart-tiered-cache:
        description: Automatically determine the best upper-tier data centers for tiered cache topology
      settings.variants:
        description: Serve different cached versions of an image based on the Accept header (WebP, AVIF, etc.)
  client-side-security:
    description: Client-Side Security — monitor JavaScript, connections, and cookies on your pages for supply-chain attacks
    groups:
      connections:
        description: Third-party connections made by scripts on your pages — track data exfiltration risks
      cookies:
        description: Cookies set by your pages with classification and same-site attribute tracking
      policies:
        description: Content Security Policies that control which scripts and connections are allowed on your pages
      scripts:
        description: JavaScript files detected on your pages with change tracking and malicious code detection
      settings:
        description: Fine tune Client-Side Security behaviors
  cloud-connector:
    description: Route traffic from Cloudflare directly to cloud provider services (AWS, Azure, GCP) without origin servers
    groups:
      rules:
        description: Routing rules that map request patterns to cloud provider endpoints
  cloudforce-one:
    description: Detection rule management APIs
    groups:
      binary-storage:
        description: Upload and retrieve malware samples and suspicious binaries for analysis
      requests:
        description: Additional request operations — priority listing and asset creation
      rules:
        description: Rule management operations
        groups:
          approvals:
            description: Approval workflow operations
          email:
            description: Email rule operations
          exemptions:
            description: Exemption rule operations
          managed:
            description: Managed rule operations
          stats:
            description: Rule statistics operations
          tree:
            description: Rule navigation tree operations
      scans:
        description: Scan URLs, IPs, and domains for threat intelligence indicators
  containers:
    description: Deploy and manage Containers applications on Cloudflare's global network
    groups:
      applications:
        description: Manage Containers applications
      applications.instances:
        description: Inspect Containers instances belonging to applications
      applications.rollouts:
        description: Manage rollouts for scheduler-backed applications
      applications.versions:
        description: Inspect versions of scheduler-backed applications
      registries:
        description: Manage Containers image registries
      registries.credentials:
        description: Generate image registry credentials
  content-scan:
    description: Malicious uploads detection, scan uploaded content in HTTP requests for malware and malicious payloads
    groups:
      expressions:
        description: Custom expressions that tell the scanner how to reach content objects it cannot parse on its own
  custom-pages:
    description: Manage custom error and challenge pages and their assets for accounts and zones
    groups:
      account-custom-pages:
        description: Manage account-level custom pages
      account-custom-pages.preview-tokens:
        description: Preview tokens for account-level custom pages
      assets:
        description: Manage account- and zone-level custom assets
      zone-custom-pages:
        description: Manage zone-level custom pages
      zone-custom-pages.preview-tokens:
        description: Preview tokens for zone-level custom pages
  d1:
    description: D1 is Cloudflare's managed, serverless database with SQLite's SQL semantics, built-in disaster recovery, and Worker and HTTP API access.
    groups:
      time-travel:
        description: use specific point-in-time backups of your D1 database
        x-forge-epilogue: For more information about Time Travel, see https://developers.cloudflare.com/d1/reference/time-travel
  diagnostics:
    description: Network diagnostic tools — traceroutes from Cloudflare's edge and endpoint health checks
    groups:
      endpoint-healthchecks:
        description: Monitor external endpoint availability with periodic HTTP/HTTPS health checks
      traceroutes:
        description: Run traceroutes from Cloudflare data centers to diagnose network path issues
  email-routing:
    description: Route incoming email to verified destination addresses or Workers with routing rules, catch-all behavior, and managed DNS records
    groups:
      addresses:
        description: Verified destination email addresses that can receive forwarded mail
      dns:
        description: Inspect or unlock the DNS records required by Email Routing
      rules:
        description: Match incoming email addresses and forward messages to destination mailboxes or Workers
      settings:
        description: Inspect and update Email Routing settings
  email-security:
    description: Cloud email security — investigate threats, manage allow/block policies, and detect phishing
    groups:
      analytics:
        description: Analytics and reporting — monthly report and per-day breakdowns of threat activity
      bulk-actions:
        description: Asynchronous jobs that move or release every message matching a search — create, monitor, and manage bulk jobs
      investigate:
        description: Search and investigate email messages — view detections, traces, raw content, and take remediation actions
      phishguard:
        description: PhishGuard user-reported phishing reports — view detected threats for a date range
      settings:
        description: Email security configuration — block senders, allow policies, content policies, domains, trusted domains, impersonation registry, and URL handling
      submissions:
        description: Reclassify submissions — track user and team reports of false positives and missed detections
  email-sending:
    description: Send transactional email and manage sending subdomains and their DNS configuration
    groups:
      limits:
        description: Inspect account-level sending quotas and current usage
      subdomains:
        description: Configure sending subdomains and keep their DNS records healthy
      suppressions:
        description: Prevent delivery to suppressed addresses and manage the account suppression list
  filters:
    description: Filter expressions used by legacy firewall rules to match requests — prefer Rulesets for new configurations
  firewall:
    description: Legacy firewall rules, zone lockdowns, access rules, user-agent blocking, and WAF packages
    groups:
      access-rules:
        description: IP-based access rules that allow, block, challenge, or whitelist traffic globally or per-zone
      lockdowns:
        description: Zone lockdown rules that restrict access to URLs by IP address or range
      rules:
        description: Legacy firewall rules with filter expressions — prefer Rulesets for new configurations
      ua-rules:
        description: Block or challenge requests based on the User-Agent header string
      waf:
        description: Legacy WAF managed rule packages, rule groups, individual rules, and override configurations
      zone-access-rules:
        description: Zone-scoped IP access rules for blocking or allowing traffic
  google-tag-gateway:
    description: Google Tag Gateway operations
    groups:
      config:
        description: Google Tag Gateway config operations
  healthchecks:
    description: Standalone health checks that monitor origin server availability from Cloudflare's edge
    groups:
      previews:
        description: Test a health check configuration before deploying it to production
  hyperdrive:
    description: Accelerate access to existing databases by caching queries and pooling connections at the edge
  iam:
    description: Identity and access management — permission groups, resource groups, user groups, and SSO connectors
    groups:
      permission-groups:
        description: View the permission groups that can be assigned to API tokens and policies
      resource-groups:
        description: Define scopes that limit which account resources a policy or token can access
      sso:
        description: Configure single sign-on connectors to authenticate account members through an external identity provider
      user-groups:
        description: Organize account members into groups for easier permission assignment
  images:
    description: Store, resize, and deliver optimized images globally — variants, signing keys, and direct uploads
    groups:
      flows:
        description: Zone-level transformation flows that control how images are resized and optimized on delivery
      import:
        description: Import images from S3
      keys:
        description: Manage signing keys for generating private image URLs
      variants:
        description: Manage named resize variants for transforming images on delivery
  intel:
    description: Threat intelligence lookups — IP reputation, domain info, ASN details, WHOIS, and indicator feeds
    groups:
      asn:
        description: ASN intelligence — ownership, geolocation, and subnet details for autonomous systems
      attack-surface-report:
        description: Attack surface intelligence — exposed assets, vulnerabilities, and infrastructure mapping
      dns:
        description: Passive DNS data showing historical DNS resolution records for domains
      domain-history:
        description: Historical domain registration and categorization changes over time
      domains:
        description: Domain intelligence — risk scores, categories, and associated infrastructure
      indicator-feeds:
        description: Threat indicator feeds — subscribe to and manage curated lists of malicious IPs, domains, and URLs
      ip-lists:
        description: Curated IP lists used for threat detection and policy enforcement
      ips:
        description: IP address intelligence — geolocation, risk assessment, and hosting provider details
      miscategorizations:
        description: Report and track domain miscategorization corrections
      whois:
        description: WHOIS registration data for domains including registrant, registrar, and nameservers
  k2:
    description: Durable, ordered event streams that you produce records to and consume from with subscriptions
    groups:
      streams:
        description: K2 streams, their retention, and the HTTP and Workers binding inputs used to produce records
      streams.subscriptions:
        description: Subscriptions that consume a K2 stream, with committed-position lag
  leaked-credential-checks:
    description: Detect compromised credentials in login requests by checking against known breach databases
    groups:
      detections:
        description: Custom detection locations that tell the WAF where to find usernames and passwords in requests
  load-balancers:
    description: Distribute traffic across origin pools with health monitoring, geo-steering, and failover
    groups:
      monitor-groups:
        description: Group monitors together for shared configuration and bulk management
      monitor-groups.references:
        description: List references to monitor groups used by load balancer pools
      monitors:
        description: Health check configurations that probe origin servers and determine pool availability
      monitors.previews:
        description: Health check configurations that probe origin servers and determine pool availability
      monitors.references:
        description: Health check configurations that probe origin servers and determine pool availability
      pools:
        description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences
      pools.health:
        description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences
      pools.references:
        description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences
      previews:
        description: Preview the result of a health check monitor configuration before applying it
      regions:
        description: Geographic regions used for regional pool steering and traffic policies
      searches:
        description: Search across all load balancer resources (pools, monitors, load balancers) by name or reference
  logs:
    description: Log control, retention, and raw log access — CMB config, ray ID lookups, and received fields
    groups:
      control:
        description: Log control operations
      received:
        description: Received log operations
  magic-network-monitoring:
    description: Flow-based network traffic monitoring with configurable alerting rules and VPC flow ingestion
    groups:
      configs:
        description: Account-level monitoring configuration — sampling rates, thresholds, and notification settings
      rules:
        description: Monitoring rules that define traffic thresholds and trigger alerts or prefix advertisements
      vpc-flows:
        description: Ingest VPC flow logs from cloud providers for network visibility and anomaly detection
  magic-transit:
    description: DDoS-protected network transit — GRE/IPsec tunnels, static routes, Magic WAN sites, connectors, and packet captures
    groups:
      advanced-dns-protection:
        description: Advanced Dns Protection operations
      advanced-tcp-protection:
        description: Advanced Tcp Protection operations
      apps:
        description: Application-aware traffic policies for Magic WAN that steer traffic by app type
      bgp-filter-profiles:
        description: BGP filter profiles for controlling which routes are allowed or denied on Magic Transit tunnels
      bgp-settings:
        description: BGP settings for controlling default ASN and route redistribution on Magic Transit tunnels
      cf-interconnects:
        description: Cloudflare Network Interconnect (CNI) links for direct physical or virtual peering
      gre-tunnels:
        description: GRE tunnel endpoints that connect your network to Cloudflare for Magic Transit
      ipsec-tunnels:
        description: IPsec tunnel endpoints with pre-shared key management for encrypted transit
      pcaps:
        description: Packet capture requests for debugging traffic flowing through Magic Transit tunnels
      routes:
        description: Static routes that direct IP prefix traffic through specific GRE/IPsec tunnels
      sites:
        description: Magic WAN branch sites — base CRUD, LAN/WAN interface configuration, ACLs, connectors, app configuration, and NetFlow config
  mcp:
    description: Manage MCP portals and upstream MCP servers for Cloudflare Access AI controls
    groups:
      portals:
        description: Manage MCP portals, attached servers, and Code Mode settings
      servers:
        description: Manage upstream MCP servers, credentials, capabilities, and sync state
  network-interconnects:
    description: Physical and virtual private interconnects between your infrastructure and Cloudflare's network
    groups:
      cnis:
        description: Cloud Network Interconnect (CNI) connections — private links from cloud providers to Cloudflare
      interconnects:
        description: Physical cross-connect and partner interconnect sessions with LOA and status tracking
      settings:
        description: Account-level interconnect settings and default configurations
      slots:
        description: Available interconnect facility slots showing port capacity at Cloudflare data centers
  organizations:
    description: Multi-user organizations that group accounts, members, and shared settings under a single entity
    groups:
      account-organizations:
        description: List organizations associated with a specific account
      accounts:
        description: Accounts operations
      members:
        description: Members operations
      members-batch-create:
        description: Members Batch Create operations
      organization-profile:
        description: View and update the public profile information for an organization
      shares:
        description: Shares operations
  origin-post-quantum-encryption:
    description: Enable post-quantum key exchange for connections between Cloudflare and your origin server
  pages:
    description: Full-stack application hosting with Git-integrated builds, preview deployments, and custom domains
    groups:
      projects:
        description: Pages projects, deployments, build logs, and custom domain bindings
  pipelines:
    description: Ingest, transform, and route event streams into R2, analytics, or other destinations in real time
    groups:
      sinks:
        description: Destinations where pipeline data is written — R2 buckets, HTTP endpoints, or other storage
      streams:
        description: Inbound data streams that feed events into a pipeline for processing
  precursor:
    description: Precursor settings for a zone
  queues:
    description: Reliable message queuing between Workers — produce, consume, and batch-process messages at scale
    groups:
      consumers:
        description: Workers that automatically receive and process messages from a queue
      messages:
        description: Push messages to a queue and pull or acknowledge them from consumers
      purge:
        description: Remove all pending messages from a queue
      subscriptions:
        description: Manage queue subscriptions for event-driven message routing
  r2:
    description: S3-compatible object storage with zero egress fees — buckets, lifecycle rules, event notifications, and data migration
    groups:
      buckets:
        description: Create and configure R2 buckets including CORS, lifecycle, custom domains, event notifications, and object locks
      buckets.jobs:
        description: Create and inspect background jobs for an R2 bucket
      buckets.local-uploads:
        description: R2 bucket local upload configuration
      super-slurper:
        description: Migrate data from external S3-compatible storage into R2 buckets with resumable transfer jobs
      temporary-credentials:
        description: Generate short-lived S3-compatible credentials scoped to specific buckets and operations
  r2-data-catalog:
    description: Iceberg-compatible data catalog for R2 — organize objects into tables and namespaces for SQL query engines
    groups:
      credentials:
        description: Catalog access credentials for external query engines (Spark, Trino, etc.)
      maintenance-configs:
        description: Table maintenance settings — compaction schedules and snapshot expiration policies
      namespaces:
        description: Logical namespaces that group related tables within the data catalog
      namespaces.tables:
        description: Tables within catalog namespaces
      namespaces.tables.maintenance-configs:
        description: Table-level maintenance configurations and operations
      namespaces.tables.maintenance-runs:
        description: History of maintenance runs performed on tables
  radar:
    description: Internet-wide traffic intelligence — BGP, DNS, HTTP trends, attack data, and network quality insights
    groups:
      agent-readiness:
        description: Agent readiness summary statistics across the Cloudflare network
      ai:
        description: AI inference trends and model usage statistics across the Cloudflare network
      annotations:
        description: Radar annotations marking significant Internet events (outages, cable cuts, etc.)
      as112:
        description: AS112 DNS sinkhole statistics — reverse DNS query volumes for private address space
      attacks:
        description: DDoS and application-layer attack trends, vectors, and target analysis
      bgp:
        description: BGP routing data — prefix announcements, AS-level stats, route leaks, and hijack events
      bots:
        description: Internet-wide bot traffic trends, categories, and distribution statistics
      ct:
        description: Certificate Transparency log monitoring and newly-issued certificate discovery
      datasets:
        description: Downloadable Radar datasets for offline analysis and research
      dns:
        description: Global DNS query trends — top domains, resolver stats, and DNSSEC adoption
      email:
        description: Email security trends — DMARC/SPF/DKIM adoption, spam, and phishing statistics
      entities:
        description: Look up ASNs, IPs, domains, and locations with metadata and traffic summaries
      geolocations:
        description: Geographic location metadata used for regional traffic analysis
      http:
        description: HTTP protocol trends — TLS versions, HTTP versions, browser share, and OS distribution
      leaked-credentials:
        description: Leaked credential detection trends and exposure statistics
      netflows:
        description: Network-layer traffic flow data and volumetric trend analysis
      origins:
        description: Cloud and hosting origin providers (e.g. Amazon, by region) and their traffic metrics
      post-quantum:
        description: Post-quantum encryption adoption and deployment trends across the Internet
      quality:
        description: Internet connection quality metrics — speed, latency, and jitter by geography and ASN
      ranking:
        description: Top domain rankings based on DNS query popularity across the Cloudflare network
      robots-txt:
        description: Robots.txt adoption and crawler directive trends across the web
      search:
        description: Search Radar data across IPs, ASNs, domains, and locations
      tcp-resets-timeouts:
        description: TCP connection reset and timeout statistics indicating network health issues
      tlds:
        description: Top-level domain (TLD) metadata and performance trends
      traffic-anomalies:
        description: Detected traffic anomalies and unusual patterns in Internet traffic flows
      verified-bots:
        description: Catalog of known good bots (Googlebot, Bingbot, etc.) and their traffic patterns
  rate-limits:
    description: Legacy per-zone rate limiting rules — prefer Advanced Rate Limiting in Rulesets for new configurations
  realtime:
    description: Real-time audio, video, and data services on Cloudflare's global network
    groups:
      kit:
        description: SDK-backed meetings, participants, recordings, livestreams, and webhooks
      kit.analytics:
        description: Usage and livestream analytics for RealtimeKit applications
      kit.analytics.livestreams:
        description: Livestream analytics for RealtimeKit applications
      kit.analytics.livestreams.daily:
        description: Daily livestream analytics for RealtimeKit applications
      kit.analytics.usage:
        description: Usage analytics for RealtimeKit applications
      kit.apps:
        description: RealtimeKit applications that group meetings, sessions, and configuration
      kit.livestreams:
        description: Independent and meeting-based livestreams and their sessions
      kit.livestreams.sessions:
        description: Sessions for RealtimeKit livestreams
      kit.meetings:
        description: Meetings, participants, access tokens, and meeting livestreams
      kit.meetings.active:
        description: Live meeting state and participant controls
      kit.meetings.active.polls:
        description: Polls for active meeting sessions
      kit.meetings.livestream:
        description: Livestream operations associated with RealtimeKit meetings
      kit.meetings.participants:
        description: Participants in RealtimeKit meetings
      kit.meetings.participants.tokens:
        description: Access tokens for RealtimeKit meeting participants
      kit.presets:
        description: Reusable meeting configuration for media, permissions, and interface behavior
      kit.recordings:
        description: Meeting and participant-track recordings and recording controls
      kit.recordings.active:
        description: Active recordings for RealtimeKit meetings
      kit.recordings.tracks:
        description: Participant-track recordings for RealtimeKit meetings
      kit.sessions:
        description: Historical session data, participants, chat, transcripts, and summaries
      kit.sessions.chat:
        description: Chat messages from historical RealtimeKit sessions
      kit.sessions.livestreams:
        description: Livestreams associated with historical RealtimeKit sessions
      kit.sessions.participants:
        description: Participants in historical RealtimeKit sessions
      kit.sessions.peers:
        description: Peer details from historical RealtimeKit sessions
      kit.sessions.summaries:
        description: Summaries of historical RealtimeKit sessions
      kit.sessions.transcripts:
        description: Transcripts from historical RealtimeKit sessions
      kit.webhooks:
        description: Webhook endpoints and supported events for RealtimeKit notifications
      kit.webhooks.events:
        description: Supported events for RealtimeKit webhooks
      moq:
        description: MoQ relays for publishing and subscribing to media streams
      moq.relays:
        description: Relays are isolated MoQ scopes that carry media between publishers and subscribers
      moq.relays.tokens:
        description: Tokens that authorize publishers and subscribers to connect to a relay
      sfu:
        description: SFU apps that route WebRTC media and data between participants
      sfu.apps:
        description: SFU application namespaces for sessions and tracks
      turn:
        description: TURN keys that help clients traverse NATs and firewalls
      turn.keys:
        description: Keys used to generate short-lived TURN credentials
  request-tracers:
    description: Trace how a request would be processed through Cloudflare's rules and configuration pipeline
    groups:
      traces:
        description: Simulate request processing to debug rule matches, transforms, and routing decisions
  resource-sharing:
    description: Share Cloudflare resources (zones, accounts) across organizations with granular access controls
    groups:
      recipients:
        description: Update share recipients
      resources:
        description: Individual resources (zones, configs) that have been shared with recipients
  rules:
    description: Resources used by Cloudflare rules and rulesets
    groups:
      lists:
        description: Custom account-level lists of IPs, hostnames, ASNs, or redirects used in rule expressions
  rum:
    description: Real User Measurement (Web Analytics) — track page loads, Core Web Vitals, and visitor metrics
    groups:
      rules:
        description: Rules that control which pages and paths are tracked by Web Analytics
      site-info:
        description: Web Analytics sites — register domains and get the JavaScript beacon snippet
  scim:
    description: SCIM 2.0 provisioning — manage users, groups, and identity provider sync for your account
    groups:
      groups:
        description: Groups operations
      resource-types:
        description: Resource Types operations
      schemas:
        description: Schemas operations
      service-provider-config:
        description: Service Provider Config operations
      users:
        description: Users operations
  secrets-store:
    description: Centralized secret management — store API keys, tokens, and credentials for use across Workers and other products
    groups:
      quota:
        description: Account quota limits for secrets stores, secrets count, and storage capacity
      secrets:
        description: Encrypted key-value secrets within a store. Pass --store-id to scope.
      stores:
        description: Secret stores that hold encrypted key-value secrets accessible by Workers and services
  security-center:
    description: Security posture dashboard — view and manage security insights, misconfigurations, and vulnerabilities
    groups:
      insights:
        description: Security findings and recommendations across your account — DNS, SSL, WAF misconfigurations, etc.
      zone-insights:
        description: Zone-scoped security insights — counts by class, severity, type, and dismissal
  security-txt:
    description: Manage the /.well-known/security.txt file that tells security researchers how to report vulnerabilities
  smart-shield:
    description: Smart Shield settings, health checks, and cache reserve management
    groups:
      cache-reserve-clear:
        description: Cache Reserve Clear operations
      health-checks:
        description: Health checks operations
  spectrum:
    description: Proxy and protect arbitrary TCP/UDP applications through Cloudflare's network with DDoS mitigation
    groups:
      analytics:
        description: Real-time and historical connection analytics for Spectrum applications
      apps:
        description: Spectrum application configurations that map protocols and ports to origin servers
  speed:
    description: Observatory speed tests — run Lighthouse audits, track performance trends, and schedule recurring tests
    groups:
      availabilities:
        description: Check which speed test regions and configurations are available for your zone
      pages:
        description: Tested pages with their performance history, trends, and individual test results
      schedule:
        description: Scheduled recurring speed tests that automatically run at regular intervals
  ssl:
    description: SSL/TLS certificate management — certificate packs, Universal SSL, verification, and TLS mode recommendations
    groups:
      automatic-upgrader:
        description: SSL automatic mode enrollment — get or update automatic SSL/TLS upgrader settings
      recommendations:
        description: Get the recommended SSL/TLS encryption mode based on your origin server's certificate configuration
  stream:
    description: Video encoding, storage, and delivery — upload, live-stream, clip, caption, and embed video at scale
    groups:
      audio-tracks:
        description: Add, edit, or remove additional audio tracks on a video
      captions:
        description: Upload, generate, or retrieve captions and subtitles for videos in multiple languages
      clip:
        description: Create a new video clip from an existing video by specifying start and end times
      copy:
        description: Import a video from a URL into Stream for processing and delivery
      direct-upload:
        description: Generate a tokenized URL that lets end-users upload video directly to Stream
      downloads:
        description: Create downloadable MP4 renditions of a video for offline viewing
      embed:
        description: Retrieve the HTML embed code snippet for a video
      keys:
        description: Signing keys used to generate short-lived signed URLs for private video playback
      live-inputs:
        description: Enable and disable live input streams
      token:
        description: Generate short-lived signed URL tokens for secure private video playback
      typed-downloads:
        description: Type-specific stream download creation and deletion
      videos:
        description: Aggregate video storage usage statistics for the account
      watermarks:
        description: Watermark profiles that overlay an image on every video in the account
      webhooks:
        description: Webhook notifications for video lifecycle events (ready, error, etc.)
  tenants:
    description: Multi-tenant account management — manage tenant accounts, entitlements, and memberships
    groups:
      account-types:
        description: Account Types operations
      accounts:
        description: Accounts operations
      entitlements:
        description: Entitlements operations
      memberships:
        description: Memberships operations
  turnstile:
    description: CAPTCHA-free bot verification widgets that protect forms and APIs without degrading user experience
    groups:
      widgets:
        description: Turnstile widget configurations — site keys, secret rotation, and challenge mode settings
  url-scanner:
    description: Scan URLs for phishing, malware, and other threats — submit scans and retrieve detailed results
    groups:
      response:
        description: Response operations
      responses:
        description: Raw HTTP response data captured during URL scans
      scan:
        description: Scan operations
      scans:
        description: URL scan requests and results — submit URLs for analysis and retrieve threat verdicts
  user:
    description: Your Cloudflare user profile, invitations, organizations, billing, and personal API tokens
    groups:
      billing:
        description: View billing history and payment profile for your user (deprecated — prefer account-level billing)
      firewall:
        description: Firewall operations
      load-balancers.monitors:
        description: Load Balancers operations
      load-balancers.monitors.preview:
        description: Load Balancers operations
      load-balancers.monitors.references:
        description: Load Balancers operations
      load-balancers.pools:
        description: Load Balancers operations
      load-balancers.pools.edit.pools:
        description: Load Balancers operations
      load-balancers.pools.health:
        description: Load Balancers operations
      load-balancers.pools.preview:
        description: Load Balancers operations
      load-balancers.pools.references:
        description: Load Balancers operations
      load-balancers.preview:
        description: Load Balancers operations
      load-balancing-analytics.events:
        description: Load Balancing Analytics operations
      subscriptions:
        description: View and manage zone-level plan subscriptions owned by your user
      tenants:
        description: Tenants operations
      tokens:
        description: Create and manage personal API tokens scoped to your user for programmatic API access
  user.analytics:
    description: User-level traffic analytics — aggregated totals and timeseries across all zones
  vectorize:
    description: Globally distributed vector database for building semantic search, recommendations, and RAG applications on Workers
    groups:
      deprecated-indexes:
        description: Deprecated v1 Vectorize index operations
      metadata-index:
        description: Metadata indexes for filtered vector search
  waiting-rooms:
    description: Virtual queues that throttle traffic to your site during peak demand with customizable waiting pages
    groups:
      account-waiting-rooms:
        description: Account-scoped waiting room listing
      events:
        description: Scheduled events that temporarily override waiting room settings for sales, launches, etc.
      page:
        description: Custom HTML waiting page templates and preview rendering
      rules:
        description: Rules that bypass or modify waiting room behavior for specific request patterns
      settings:
        description: Zone-level waiting room defaults and cookie configuration
      statuses:
        description: Real-time queue status showing active users, queued users, and estimated wait times
  workflows:
    description: Durable, multi-step workflows that run on Workers with automatic retries and state persistence
    groups:
      instances:
        description: Workflow instance operations
      versions:
        description: Workflow version operations
  zaraz:
    description: Server-side tag manager — load third-party tools (analytics, pixels, etc.) from Cloudflare's edge without client-side JS
    groups:
      config:
        description: Full Zaraz configuration including tools, triggers, and variables for the zone
      default:
        description: Default Zaraz configuration template used as a starting point for new zones
      export:
        description: Export the current Zaraz configuration as a portable JSON document
      history:
        description: Configuration version history — browse and restore previous Zaraz configurations
      publish:
        description: Publish pending Zaraz configuration changes to make them live on the zone
      workflow:
        description: Workflow state for Zaraz configuration changes (draft vs. published)
  zero-trust:
    description: Cloudflare's SASE platform — secure access, device posture, DLP, tunnels, gateway policies, and network segmentation
    groups:
      dex:
        description: Digital Experience Monitoring — synthetic tests, fleet-wide device metrics, and network path diagnostics
      dlp.custom-prompt-topics:
        description: Data Loss Prevention - manage custom prompt topics for AI-based content detection
      dlp.data-classes:
        description: Data Loss Prevention - manage data classes used to classify sensitive information
      dlp.data-tag-categories:
        description: Data Loss Prevention - manage categories that organize data tags
      dlp.data-tag-category-templates:
        description: Data Loss Prevention - browse templates for creating data tag categories
      dlp.data-tags:
        description: Data Loss Prevention - manage tags used to classify and organize sensitive data
      dlp.datasets:
        description: Data Loss Prevention - manage datasets, versions, and uploads
      dlp.document-fingerprints:
        description: Data Loss Prevention - manage document fingerprints for detecting matching documents
      dlp.email.account-mapping:
        description: Data Loss Prevention - configure account mappings for outbound email scanning
      dlp.email.rules:
        description: Data Loss Prevention - manage outbound email scanning rules and their priorities
      dlp.entries:
        description: Data Loss Prevention - list and manage detection entries
      dlp.limits:
        description: Data Loss Prevention - view account limits and resource quotas
      dlp.patterns:
        description: Data Loss Prevention - validate regular expressions used for content detection
      dlp.profiles:
        description: Data Loss Prevention - list and retrieve profiles
      dlp.profiles.custom:
        description: Data Loss Prevention - manage custom profiles
      dlp.profiles.predefined:
        description: Data Loss Prevention - manage predefined profiles
      dlp.sensitivity-group-templates:
        description: Data Loss Prevention - browse templates for creating sensitivity groups
      dlp.sensitivity-groups:
        description: Data Loss Prevention - manage sensitivity groups and their level ordering
      dlp.sensitivity-levels:
        description: Data Loss Prevention - manage sensitivity levels within sensitivity groups
      dlp.settings:
        description: Data Loss Prevention - manage account-level settings
      dlp.validators:
        description: Data Loss Prevention - list and retrieve content validators
      dlp.validators.proximity-words:
        description: Data Loss Prevention - manage proximity-word validators
      risk-scoring:
        description: User Risk Scoring - retrieve and reset user risk scores
      risk-scoring.behaviours:
        description: User Risk Scoring - manage behaviors used to calculate user risk scores
      risk-scoring.integrations:
        description: User Risk Scoring - manage integrations that provide risk score signals
      risk-scoring.integrations.references:
        description: User Risk Scoring - retrieve integrations by external reference
      risk-scoring.summary:
        description: User Risk Scoring - retrieve account risk score summaries
  zones:
    description: Zones are domains on Cloudflare — list, create, and configure domain settings
    groups:
      aegis:
        description: Aegis operations
      fonts:
        description: Fonts operations
      origin-h2-max-streams:
        description: Origin H2 Max Streams operations
      origin-max-http-version:
        description: Origin Max Http Version operations
      origin-tls-compliance-modes:
        description: Manage zone Origin TLS Compliance Modes setting
      rum:
        description: Rum operations
      speed-brain:
        description: Speed Brain operations