APIs.io Engineering Platform Queue API

openapi: 3.2.0
info:
  description: 'To get started using Cloudflare''s products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources.


    Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions.


    To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to

    our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/).


    Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/).'
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  title: APIs.io Engineering Platform Cloudflare Queue API
  version: 4.0.0
tags:
- name: Queue
paths:
  /accounts/{account_id}/queues:
    get:
      description: Returns the queues owned by an account.
      operationId: queue-v2-list-queues
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      errors: {}
                  - properties:
                      messages: {}
                  - properties:
                      result_info:
                        properties:
                          count:
                            example: 1
                          page:
                            example: 1
                          per_page:
                            example: 100
                          total_count:
                            example: 1
                          total_pages:
                            example: 1
                        type: object
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/mq_queue'
                        type: array
                    required:
                    - queue_id
                    - queue_name
                    - created_on
                    - modified_on
                    - producers_total_count
                    - producers
                    - consumers_total_count
                    - consumers
                    type: object
                - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: List Queues response failure.
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mq_api-response-collection'
                - properties:
                    errors: {}
                - properties:
                    messages: {}
                - properties:
                    result_info:
                      properties:
                        count:
                          example: 1
                        page:
                          example: 1
                        per_page:
                          example: 100
                        total_count:
                          example: 1
                        total_pages:
                          example: 1
                      type: object
                - properties:
                    result:
                      items:
                        $ref: '#/components/schemas/mq_queue'
                      type: array
                  required:
                  - queue_id
                  - queue_name
                  - created_on
                  - modified_on
                  - producers_total_count
                  - producers
                  - consumers_total_count
                  - consumers
                  type: object
          description: List Queues response.
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform List Queues
      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
    post:
      description: Creates a new queue.
      operationId: queue-v2-create-queue
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              example:
                queue_name: example-queue
              properties:
                queue_name:
                  type: string
              required:
              - queue_name
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      result:
                        allOf:
                        - $ref: '#/components/schemas/mq_queue_created'
                        type: object
                    required:
                    - queue_id
                    - queue_name
                    - created_on
                    - modified_on
                    type: object
                - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Create Queue response failure.
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mq_api-response-collection'
                - properties:
                    result:
                      allOf:
                      - $ref: '#/components/schemas/mq_queue_created'
                      type: object
                  required:
                  - queue_id
                  - queue_name
                  - created_on
                  - modified_on
                  type: object
          description: Create Queue response.
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Create Queue
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.create
  /accounts/{account_id}/queues/{queue_id}:
    delete:
      description: Deletes a queue.
      operationId: queue-v2-delete-queue
      parameters:
      - in: path
        name: queue_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      result: {}
                - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Delete Queue response failure.
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mq_api-response-collection'
                - properties:
                    result: {}
          description: Delete Queue response.
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Delete Queue
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.delete
    get:
      description: Get information about a specific queue.
      operationId: queue-v2-queue-details
      parameters:
      - in: path
        name: queue_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      result:
                        allOf:
                        - $ref: '#/components/schemas/mq_queue'
                        type: object
                    required:
                    - queue_id
                    - queue_name
                    - created_on
                    - modified_on
                    type: object
                - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Queue Details response failure.
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mq_api-response-collection'
                - properties:
                    result:
                      allOf:
                      - $ref: '#/components/schemas/mq_queue'
                      type: object
                  required:
                  - queue_id
                  - queue_name
                  - created_on
                  - modified_on
                  type: object
          description: Queue Details response.
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Queue Details
      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
    put:
      description: Updates a queue.
      operationId: queue-v2-update-queue
      parameters:
      - in: path
        name: queue_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              example:
                queue_name: renamed-example-queue
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      result:
                        allOf:
                        - $ref: '#/components/schemas/mq_queue_updated'
                        type: object
                    required:
                    - queue_id
                    - queue_name
                    - created_on
                    - modified_on
                    type: object
                - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Update Queue response failure.
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mq_api-response-collection'
                - properties:
                    result:
                      allOf:
                      - $ref: '#/components/schemas/mq_queue_updated'
                      type: object
                  required:
                  - queue_id
                  - queue_name
                  - created_on
                  - modified_on
                  type: object
          description: Update Queue response.
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Update Queue
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.update
  /accounts/{account_id}/queues/{queue_id}/consumers:
    get:
      description: Returns the consumers for a queue.
      operationId: queue-v2-list-queue-consumers
      parameters:
      - in: path
        name: queue_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      errors: {}
                  - properties:
                      messages: {}
                  - properties:
                      result_info:
                        properties:
                          count:
                            example: 1
                          page:
                            example: 1
                          per_page:
                            example: 100
                          total_count:
                            example: 1
                          total_pages:
                            example: 1
                        type: object
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/mq_consumer'
                        type: array
                    required:
                    - queue_name
                    - created_on
                    - settings
                    type: object
                - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: List Queue Consumers response failure.
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mq_api-response-collection'
                - properties:
                    errors: {}
                - properties:
                    messages: {}
                - properties:
                    result_info:
                      properties:
                        count:
                          example: 1
                        page:
                          example: 1
                        per_page:
                          example: 100
                        total_count:
                          example: 1
                        total_pages:
                          example: 1
                      type: object
                - properties:
                    result:
                      items:
                        $ref: '#/components/schemas/mq_consumer'
                      type: array
                  required:
                  - queue_name
                  - created_on
                  - settings
                  type: object
          description: List Queue Consumers response.
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform List Queue Consumers
      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
    post:
      description: Creates a new consumer for a queue.
      operationId: queue-v2-create-queue-consumer
      parameters:
      - in: path
        name: queue_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              example:
                dead_letter_queue: example-dlq
                environment: production
                script_name: example-consumer
                settings:
                  batch_size: 10
                  max_retries: 3
                  max_wait_time_ms: 5000
                type: worker
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      result:
                        allOf:
                        - $ref: '#/components/schemas/mq_consumer_created'
                        type: object
                    required:
                    - queue_name
                    - script_name
                    - settings
                    - dead_letter_queue
                    - created_on
                    type: object
                - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Create Queue Consumer response failure.
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mq_api-response-collection'
                - properties:
                    result:
                      allOf:
                      - $ref: '#/components/schemas/mq_consumer_created'
                      type: object
                  required:
                  - queue_name
                  - script_name
                  - settings
                  - dead_letter_queue
                  - created_on
                  type: object
          description: Create Queue Consumer response.
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Create Queue Consumer
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.create
  /accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}:
    delete:
      description: Deletes the consumer for a queue.
      operationId: queue-v2-delete-queue-consumer
      parameters:
      - in: path
        name: consumer_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - in: path
        name: queue_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      result: {}
                - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Delete Queue Consumer response failure.
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mq_api-response-collection'
                - properties:
                    result: {}
          description: Delete Queue Consumer response.
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Delete Queue Consumer
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.delete
    put:
      description: Updates the consumer for a queue, or creates one if it does not exist.
      operationId: queue-v2-update-queue-consumer
      parameters:
      - in: path
        name: consumer_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - in: path
        name: queue_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              example:
                dead_letter_queue: updated-example-dlq
                environment: production
                script_name: example-consumer
                settings:
                  batch_size: 100
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      result:
                        allOf:
                        - $ref: '#/components/schemas/mq_consumer_updated'
                        type: object
                    required:
                    - queue_name
                    - script_name
                    - settings
                    - dead_letter_queue
                    - created_on
                    type: object
                - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Update Queue Consumer response failure.
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mq_api-response-collection'
                - properties:
                    result:
                      allOf:
                      - $ref: '#/components/schemas/mq_consumer_updated'
                      type: object
                  required:
                  - queue_name
                  - script_name
                  - settings
                  - dead_letter_queue
                  - created_on
                  type: object
          description: Update Queue Consumer response.
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Update Queue Consumer
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.update
  /accounts/{account_id}/queues/{queue_id}/messages/ack:
    post:
      description: Acknowledge + Retry messages from a Queue.
      operationId: queue-v2-messages-ack
      parameters:
      - in: path
        name: queue_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                acks:
                  items:
                    properties:
                      lease_id:
                        description: Lease ID for a message to acknowledge.
                        example: eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIn0..Q8p21d7dceR6vUfwftONdQ.JVqZgAS-Zk7MqmqccYtTHeeMElNHaOMigeWdb8LyMOg.T2_HV99CYzGaQuhTyW8RsgbnpTRZHRM6N7UoSaAKeK0
                        type: string
                    type: object
                  type: array
                retries:
                  items:
                    properties:
                      delay_seconds:
                        description: The number of seconds to delay before making the message available for another attempt.
                        example: 10
                        type: number
                      lease_id:
                        description: Lease ID for a message to retry.
                        example: eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIn0..Q8p21d7dceR6vUfwftONdQ.JVqZgAS-Zk7MqmqccYtTHeeMElNHaOMigeWdb8LyMOg.T2_HV99CYzGaQuhTyW8RsgbnpTRZHRM6N7UoSaAKeK0
                        type: string
                    type: object
                  type: array
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      result: {}
                - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Acknoweldge Queue Messages response failure.
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mq_api-response-collection'
                - properties:
                    result:
                      properties:
                        ackCount:
                          description: The number of messages that were succesfully acknowledged.
                          example: 5
                          type: number
                        retryCount:
                          description: The number of messages that were succesfully retried.
                          example: 5
                          type: number
                        warnings:
                          items:
                            type: string
                          type: array
                      type: object
          description: Acknoweldge Queue Messages response.
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Acknowledge + Retry Queue Messages
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.update
  /accounts/{account_id}/queues/{queue_id}/messages/pull:
    post:
      description: Pull a batch of messages from a Queue.
      operationId: queue-v2-messages-pull
      parameters:
      - in: path
        name: queue_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                batch_size:
                  $ref: '#/components/schemas/mq_batch_size'
                visibility_timeout:
                  $ref: '#/components/schemas/mq_visibility_timeout'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      result: {}
                - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Pull Queue Messages response failure.
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mq_api-response-collection'
                - properties:
                    result:
                      items:
                        $ref: '#/components/schemas/mq_queue_message'
                      type: array
          description: Pull Queue Messages response.
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Pull Queue Messages
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.update
components:
  schemas:
    mq_producer:
      properties:
        environment:
          readOnly: true
          type: string
        service:
          readOnly: true
          type: string
      type: object
    mq_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/mq_messages'
        messages:
          $ref: '#/components/schemas/mq_messages'
        result:
          anyOf:
          - type: object
          - items: {}
            type: array
          - type: string
        success:
          description: Whether the API call was successful.
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    mq_identifier:
      description: Identifier.
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    mq_max_wait_time_ms:
      example: 5000
      type: number
    mq_consumer_updated:
      properties:
        created_on:
          readOnly: true
          type: string
        dead_letter_queue:
          example: updated-example-dlq
        environment:
          readOnly: true
          type: string
        queue_name:
          readOnly: true
          type: string
        script_name:
          readOnly: true
          type: string
        settings:
          properties:
            batch_size:
              example: 100
              type: number
            max_retries:
              $ref: '#/components/schemas/mq_max_retries'
            max_wait_time_ms:
              $ref: '#/components/schemas/mq_max_wait_time_ms'
          type: object
      type: object
    mq_queue_updated:
      properties:
        created_on:
          readOnly: true
          type: string
        modified_on:
          readOnly: true
          type: string
        queue_id:
          readOnly: true
          type: string
        queue_name:
          $ref: '#/components/schemas/mq_renamed_name'
      type: object
    mq_max_retries:
      description: The maximum number of retries
      example: 3
      type: number
    mq_result_info:
      properties:
        count:
          description: Total number of results for the requested service.
          example: 1
          type: number
        page:
          description: Current page within paginated list of results.
          example: 1
          type: number
        per_page:
          description: Number of results per page of results.
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters.
          example: 2000
          type: number
      type: object
    mq_batch_size:
      description: The maximum number of messages to include in a batch.
      example: 50
      type: number
    mq_name:
      example: example-queue
      type: string
    mq_consumer:
      properties:
        created_on:
          readOnly: true
          type: string
        environment:
          readOnly: true
          type: string
        queue_name:
          readOnly: true
          type: string
        service:
          readOnly: true
          type: string
        settings:
          properties:
            batch_size:
              $ref: '#/components/schemas/mq_batch_size'
            max_retries:
              $ref: '#/components/schemas/mq_max_retries'
            max_wait_time_ms:
              $ref: '#/components/schemas/mq_max_wait_time_ms'
          type: object
      type: object
    mq_queue_created:
      properties:
        created_on:
          readOnly: true
          type: string
        modified_on:
          readOnly: true
          type: strin

# --- truncated at 32 KB (36 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/engineering-platform/refs/heads/main/openapi/engineering-platform-queue-api-openapi.yml