APIs.io Engineering Platform Worker Domain 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 Worker Domain API
  version: 4.0.0
tags:
- name: Worker Domain
paths:
  /accounts/{account_id}/workers/domains:
    get:
      description: Lists all Worker Domains for an account.
      operationId: worker-domain-list-domains
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/workers_account_identifier'
      - in: query
        name: zone_name
        schema:
          $ref: '#/components/schemas/workers_zone_name'
      - in: query
        name: service
        schema:
          $ref: '#/components/schemas/workers_schemas-service'
      - in: query
        name: zone_id
        schema:
          $ref: '#/components/schemas/workers_zone_identifier'
      - in: query
        name: hostname
        schema:
          description: Hostname of the Worker Domain.
          example: foo.example.com
          type: string
      - in: query
        name: environment
        schema:
          description: Worker environment associated with the zone and hostname.
          example: production
          type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/workers_domain-response-collection'
                - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: List Domains response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_domain-response-collection'
          description: List Domains response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Domains
      tags:
      - Worker Domain
      x-api-token-group:
      - Workers Scripts Write
      - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.domain.list
    put:
      description: Attaches a Worker to a zone and hostname.
      operationId: worker-domain-attach-to-domain
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/workers_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                environment:
                  $ref: '#/components/schemas/workers_schemas-environment'
                hostname:
                  $ref: '#/components/schemas/workers_hostname'
                service:
                  $ref: '#/components/schemas/workers_schemas-service'
                zone_id:
                  $ref: '#/components/schemas/workers_zone_identifier'
              required:
              - zone_id
              - hostname
              - service
              - environment
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/workers_domain-response-single'
                - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Attach to Domain response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_domain-response-single'
          description: Attach to Domain response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Attach to Domain
      tags:
      - Worker Domain
      x-api-token-group:
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.domain.update
  /accounts/{account_id}/workers/domains/{domain_id}:
    delete:
      description: Detaches a Worker from a zone and hostname.
      operationId: worker-domain-detach-from-domain
      parameters:
      - in: path
        name: domain_id
        required: true
        schema:
          $ref: '#/components/schemas/workers_domain_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/workers_account_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json: {}
          description: Detach from Domain response failure
        '200':
          content:
            application/json: {}
          description: Detach from Domain response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Detach from Domain
      tags:
      - Worker Domain
      x-api-token-group:
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.domain.delete
    get:
      description: Gets a Worker domain.
      operationId: worker-domain-get-a-domain
      parameters:
      - in: path
        name: domain_id
        required: true
        schema:
          $ref: '#/components/schemas/workers_domain_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/workers_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/workers_domain-response-single'
                - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Get a Domain response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_domain-response-single'
          description: Get a Domain response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get a Domain
      tags:
      - Worker Domain
      x-api-token-group:
      - Workers Scripts Write
      - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.domain.read
components:
  schemas:
    workers_schemas-environment:
      description: Worker environment associated with the zone and hostname.
      example: production
      type: string
    workers_domain-response-single:
      allOf:
      - $ref: '#/components/schemas/workers_api-response-common'
      - properties:
          result:
            $ref: '#/components/schemas/workers_domain'
        type: object
    workers_schemas-service:
      description: Worker service associated with the zone and hostname.
      example: foo
      type: string
    workers_domain_identifier:
      description: Identifer of the Worker Domain.
      example: dbe10b4bc17c295377eabd600e1787fd
      type: string
    workers_zone_name:
      description: Name of the zone.
      example: example.com
      type: string
    workers_domain-response-collection:
      allOf:
      - $ref: '#/components/schemas/workers_api-response-common'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/workers_domain'
            type: array
        type: object
    workers_account_identifier:
      description: Identifer of the account.
      example: 9a7806061c88ada191ed06f989cc3dac
      type: string
    workers_domain:
      properties:
        environment:
          $ref: '#/components/schemas/workers_schemas-environment'
        hostname:
          $ref: '#/components/schemas/workers_hostname'
        id:
          $ref: '#/components/schemas/workers_domain_identifier'
        service:
          $ref: '#/components/schemas/workers_schemas-service'
        zone_id:
          $ref: '#/components/schemas/workers_zone_identifier'
        zone_name:
          $ref: '#/components/schemas/workers_zone_name'
      type: object
    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_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_zone_identifier:
      description: Identifier of the zone.
      example: 593c9c94de529bbbfaac7c53ced0447d
      type: string
    workers_hostname:
      description: Hostname of the Worker Domain.
      example: foo.example.com
      type: string
    workers_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
  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