APIs.io Engineering Platform Durable Objects Namespace 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 Durable Objects Namespace API
  version: 4.0.0
tags:
- name: Durable Objects Namespace
paths:
  /accounts/{account_id}/workers/durable_objects/namespaces:
    get:
      description: Returns the Durable Object namespaces owned by an account.
      operationId: durable-objects-namespace-list-namespaces
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/workers_api-response-collection'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/workers_namespace'
                        type: array
                    type: object
                - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: List Namespaces response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/workers_api-response-collection'
                - properties:
                    result:
                      items:
                        $ref: '#/components/schemas/workers_namespace'
                      type: array
                  type: object
          description: List Namespaces response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Namespaces
      tags:
      - Durable Objects Namespace
      x-api-token-group:
      - Workers Scripts Write
      - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.durable-object.class.list
  /accounts/{account_id}/workers/durable_objects/namespaces/{id}/objects:
    get:
      description: Returns the Durable Objects in a given namespace.
      operationId: durable-objects-namespace-list-objects
      parameters:
      - in: path
        name: id
        required: true
        schema:
          $ref: '#/components/schemas/workers_schemas-id'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      - in: query
        name: limit
        schema:
          default: 1000
          description: The number of objects to return. The cursor attribute may be used to iterate over the next batch of objects if there are more than the limit.
          maximum: 10000
          minimum: 10
          type: number
      - in: query
        name: cursor
        schema:
          description: Opaque token indicating the position from which to continue when requesting the next set of records. A valid value for the cursor can be obtained from the cursors object in the result_info structure.
          example: AAAAANuhDN7SjacTnSVsDu3WW1Lvst6dxJGTjRY5BhxPXdf6L6uTcpd_NVtjhn11OUYRsVEykxoUwF-JQU4dn6QylZSKTOJuG0indrdn_MlHpMRtsxgXjs-RPdHYIVm3odE_uvEQ_dTQGFm8oikZMohns34DLBgrQpc
          type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/workers_api-response-collection'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/workers_object'
                        type: array
                      result_info:
                        properties:
                          count:
                            description: Total results returned based on your list parameters.
                            example: 1
                            type: number
                          cursor:
                            $ref: '#/components/schemas/workers_cursor'
                    type: object
                - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: List Objects response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/workers_api-response-collection'
                - properties:
                    result:
                      items:
                        $ref: '#/components/schemas/workers_object'
                      type: array
                    result_info:
                      properties:
                        count:
                          description: Total results returned based on your list parameters.
                          example: 1
                          type: number
                        cursor:
                          $ref: '#/components/schemas/workers_cursor'
                  type: object
          description: List Objects response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Objects
      tags:
      - Durable Objects Namespace
      x-api-token-group:
      - Workers Scripts Write
      - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.durable-object.class.read
components:
  schemas:
    workers_cursor:
      description: Opaque token indicating the position from which to continue when requesting the next set of records. A valid value for the cursor can be obtained from the cursors object in the result_info structure.
      example: AAAAANuhDN7SjacTnSVsDu3WW1Lvst6dxJGTjRY5BhxPXdf6L6uTcpd_NVtjhn11OUYRsVEykxoUwF-JQU4dn6QylZSKTOJuG0indrdn_MlHpMRtsxgXjs-RPdHYIVm3odE_uvEQ_dTQGFm8oikZMohns34DLBgrQpc
      type: string
    workers_schemas-id:
      description: ID of the namespace.
      example: 5fd1cafff895419c8bcc647fc64ab8f0
      type: string
    workers_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/workers_messages'
        messages:
          $ref: '#/components/schemas/workers_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    workers_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
    workers_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    workers_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/workers_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/workers_messages'
          example: []
        result:
          enum:
          - null
          type:
          - object
          - 'null'
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    workers_object:
      properties:
        hasStoredData:
          description: Whether the Durable Object has stored data.
          example: true
          readOnly: true
          type: boolean
        id:
          description: ID of the Durable Object.
          example: fe7803fc55b964e09d94666545aab688d360c6bda69ba349ced1e5f28d2fc2c8
          readOnly: true
          type: string
      type: object
    workers_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/workers_api-response-common'
      - properties:
          result_info:
            $ref: '#/components/schemas/workers_result_info'
      type: object
    workers_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    workers_namespace:
      properties:
        class:
          type: string
        id:
          readOnly: true
          type: string
        name:
          type: string
        script:
          type: string
        use_sqlite:
          type: boolean
      type: object
  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