APIs.io Engineering Platform Zero Trust Gateway Locations 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 Zero Trust Gateway Locations API
  version: 4.0.0
tags:
- name: Zero Trust Gateway Locations
paths:
  /accounts/{account_id}/gateway/locations:
    get:
      description: Fetches Zero Trust Gateway locations for an account.
      operationId: zero-trust-gateway-locations-list-zero-trust-gateway-locations
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/zero-trust-gateway_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zero-trust-gateway_components-schemas-response_collection'
                - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: List Zero Trust Gateway locations response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_components-schemas-response_collection'
          description: List Zero Trust Gateway locations response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Zero Trust Gateway locations
      tags:
      - Zero Trust Gateway Locations
    post:
      description: Creates a new Zero Trust Gateway location.
      operationId: zero-trust-gateway-locations-create-zero-trust-gateway-location
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                client_default:
                  $ref: '#/components/schemas/zero-trust-gateway_client-default'
                dns_destination_ips_id:
                  $ref: '#/components/schemas/zero-trust-gateway_dns-destination-ips-id-write'
                ecs_support:
                  $ref: '#/components/schemas/zero-trust-gateway_ecs-support'
                endpoints:
                  $ref: '#/components/schemas/zero-trust-gateway_endpoints'
                name:
                  $ref: '#/components/schemas/zero-trust-gateway_schemas-name'
                networks:
                  $ref: '#/components/schemas/zero-trust-gateway_ipv4_networks'
              required:
              - name
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zero-trust-gateway_components-schemas-single_response'
                - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Create a Zero Trust Gateway location response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_components-schemas-single_response'
          description: Create a Zero Trust Gateway location response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create a Zero Trust Gateway location
      tags:
      - Zero Trust Gateway Locations
  /accounts/{account_id}/gateway/locations/{location_id}:
    delete:
      description: Deletes a configured Zero Trust Gateway location.
      operationId: zero-trust-gateway-locations-delete-zero-trust-gateway-location
      parameters:
      - in: path
        name: location_id
        required: true
        schema:
          $ref: '#/components/schemas/zero-trust-gateway_components-schemas-uuid'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zero-trust-gateway_empty_response'
                - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Delete a Zero Trust Gateway location response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_empty_response'
          description: Delete a Zero Trust Gateway location response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete a Zero Trust Gateway location
      tags:
      - Zero Trust Gateway Locations
    get:
      description: Fetches a single Zero Trust Gateway location.
      operationId: zero-trust-gateway-locations-zero-trust-gateway-location-details
      parameters:
      - in: path
        name: location_id
        required: true
        schema:
          $ref: '#/components/schemas/zero-trust-gateway_components-schemas-uuid'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/zero-trust-gateway_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zero-trust-gateway_components-schemas-single_response'
                - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Get Zero Trust Gateway location details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_components-schemas-single_response'
          description: Get Zero Trust Gateway location details response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get Zero Trust Gateway location details
      tags:
      - Zero Trust Gateway Locations
    put:
      description: Updates a configured Zero Trust Gateway location.
      operationId: zero-trust-gateway-locations-update-zero-trust-gateway-location
      parameters:
      - in: path
        name: location_id
        required: true
        schema:
          $ref: '#/components/schemas/zero-trust-gateway_components-schemas-uuid'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                client_default:
                  $ref: '#/components/schemas/zero-trust-gateway_client-default'
                dns_destination_ips_id:
                  $ref: '#/components/schemas/zero-trust-gateway_dns-destination-ips-id-write'
                ecs_support:
                  $ref: '#/components/schemas/zero-trust-gateway_ecs-support'
                endpoints:
                  $ref: '#/components/schemas/zero-trust-gateway_endpoints'
                name:
                  $ref: '#/components/schemas/zero-trust-gateway_schemas-name'
                networks:
                  $ref: '#/components/schemas/zero-trust-gateway_ipv4_networks'
              required:
              - name
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zero-trust-gateway_components-schemas-single_response'
                - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Update a Zero Trust Gateway location response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_components-schemas-single_response'
          description: Update a Zero Trust Gateway location response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update a Zero Trust Gateway location
      tags:
      - Zero Trust Gateway Locations
components:
  schemas:
    zero-trust-gateway_ip_network:
      properties:
        network:
          description: The IP address or IP CIDR.
          example: 2001:85a3::/64
          type: string
      required:
      - network
      type: object
    zero-trust-gateway_ipv4_endpoint:
      properties:
        enabled:
          description: True if the endpoint is enabled for this location.
          example: true
          type: boolean
      type: object
    zero-trust-gateway_ipv6_networks:
      description: A list of allowed source IPv6 network ranges for this endpoint. When empty, all source IPs are allowed. A non-empty list is only effective if the endpoint is enabled for this location.
      items:
        $ref: '#/components/schemas/zero-trust-gateway_ipv6_network'
      type: array
    zero-trust-gateway_subdomain:
      description: The DNS over HTTPS domain to send DNS requests to. This field is auto-generated by Gateway.
      example: oli3n9zkz5
      type: string
    zero-trust-gateway_endpoints:
      description: The destination endpoints configured for this location. When updating a location, if this field is absent or set with null, the endpoints configuration remains unchanged.
      properties:
        doh:
          $ref: '#/components/schemas/zero-trust-gateway_doh_endpoint'
        dot:
          $ref: '#/components/schemas/zero-trust-gateway_dot_endpoint'
        ipv4:
          $ref: '#/components/schemas/zero-trust-gateway_ipv4_endpoint'
        ipv6:
          $ref: '#/components/schemas/zero-trust-gateway_ipv6_endpoint'
      type: object
    zero-trust-gateway_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/zero-trust-gateway_locations'
    zero-trust-gateway_dns-destination-ips-id-read:
      description: The identifier of the pair of IPv4 addresses assigned to this location.
      example: 0e4a32c6-6fb8-4858-9296-98f51631e8e6
      type: string
    zero-trust-gateway_locations:
      properties:
        client_default:
          $ref: '#/components/schemas/zero-trust-gateway_client-default'
        created_at:
          $ref: '#/components/schemas/zero-trust-gateway_timestamp'
        dns_destination_ips_id:
          $ref: '#/components/schemas/zero-trust-gateway_dns-destination-ips-id-read'
        doh_subdomain:
          $ref: '#/components/schemas/zero-trust-gateway_subdomain'
        ecs_support:
          $ref: '#/components/schemas/zero-trust-gateway_ecs-support'
        endpoints:
          $ref: '#/components/schemas/zero-trust-gateway_endpoints'
        id:
          $ref: '#/components/schemas/zero-trust-gateway_components-schemas-uuid'
        ip:
          $ref: '#/components/schemas/zero-trust-gateway_ip'
        ipv4_destination:
          description: The primary destination IPv4 address from the pair identified by the dns_destination_ips_id. This field is read-only.
          example: 172.64.36.1
          type: string
        ipv4_destination_backup:
          description: The backup destination IPv4 address from the pair identified by the dns_destination_ips_id. This field is read-only.
          example: 172.64.36.2
          type: string
        name:
          $ref: '#/components/schemas/zero-trust-gateway_schemas-name'
        networks:
          $ref: '#/components/schemas/zero-trust-gateway_ipv4_networks'
        updated_at:
          $ref: '#/components/schemas/zero-trust-gateway_timestamp'
      type: object
    zero-trust-gateway_dot_endpoint:
      properties:
        enabled:
          description: True if the endpoint is enabled for this location.
          example: true
          type: boolean
        networks:
          $ref: '#/components/schemas/zero-trust-gateway_ip_networks'
      type: object
    zero-trust-gateway_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    zero-trust-gateway_empty_response:
      allOf:
      - $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
      - properties:
          result:
            type: object
    zero-trust-gateway_identifier:
      example: 699d98642c564d2e855e9661899b7252
      type: string
    zero-trust-gateway_ip:
      description: IPV6 destination ip assigned to this location. DNS requests sent to this IP will counted as the request under this location. This field is auto-generated by Gateway.
      example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
      type: string
    zero-trust-gateway_components-schemas-uuid:
      example: ed35569b41ce4d1facfe683550f54086
      type: string
    zero-trust-gateway_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/zero-trust-gateway_messages'
        messages:
          $ref: '#/components/schemas/zero-trust-gateway_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    zero-trust-gateway_ipv6_endpoint:
      properties:
        enabled:
          description: True if the endpoint is enabled for this location.
          example: true
          type: boolean
        networks:
          $ref: '#/components/schemas/zero-trust-gateway_ipv6_networks'
      type: object
    zero-trust-gateway_dns-destination-ips-id-write:
      description: The identifier of the pair of IPv4 addresses assigned to this location. When creating a location, if this field is absent or set with null, the pair of shared IPv4 addresses (0e4a32c6-6fb8-4858-9296-98f51631e8e6) is auto-assigned. When updating a location, if the field is absent or set with null, the pre-assigned pair remains unchanged.
      example: 0e4a32c6-6fb8-4858-9296-98f51631e8e6
      type: string
    zero-trust-gateway_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
    zero-trust-gateway_api-response-single:
      allOf:
      - $ref: '#/components/schemas/zero-trust-gateway_api-response-common'
      type: object
    zero-trust-gateway_timestamp:
      example: '2014-01-01T05:20:00.12345Z'
      format: date-time
      type: string
    zero-trust-gateway_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/zero-trust-gateway_api-response-common'
      - properties:
          result_info:
            $ref: '#/components/schemas/zero-trust-gateway_result_info'
      type: object
    zero-trust-gateway_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/zero-trust-gateway_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/zero-trust-gateway_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
    zero-trust-gateway_ipv4_network:
      properties:
        network:
          description: The IPv4 address or IPv4 CIDR. IPv4 CIDRs are limited to a maximum of /24.
          example: 192.0.2.1/32
          type: string
      required:
      - network
      type: object
    zero-trust-gateway_ipv4_networks:
      description: A list of network ranges that requests from this location would originate from. A non-empty list is only effective if the ipv4 endpoint is enabled for this location.
      items:
        $ref: '#/components/schemas/zero-trust-gateway_ipv4_network'
      type: array
    zero-trust-gateway_ecs-support:
      description: True if the location needs to resolve EDNS queries.
      example: false
      type: boolean
    zero-trust-gateway_doh_endpoint:
      properties:
        enabled:
          description: True if the endpoint is enabled for this location.
          example: true
          type: boolean
        networks:
          $ref: '#/components/schemas/zero-trust-gateway_ip_networks'
        require_token:
          description: True if the endpoint requires [user identity](https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/agentless/dns/dns-over-https/#filter-doh-requests-by-user) authentication.
          example: true
          type: boolean
      type: object
    zero-trust-gateway_schemas-name:
      description: The name of the location.
      example: Austin Office Location
      type: string
    zero-trust-gateway_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/zero-trust-gateway_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/zero-trust-gateway_locations'
            type: array
    zero-trust-gateway_client-default:
      description: True if the location is the default location.
      example: false
      type: boolean
    zero-trust-gateway_ipv6_network:
      properties:
        network:
          description: The IPv6 address or IPv6 CIDR.
          example: 2001:85a3::/64
          type: string
      required:
      - network
      type: object
    zero-trust-gateway_ip_networks:
      description: A list of allowed source IP network ranges for this endpoint. When empty, all source IPs are allowed. A non-empty list is only effective if the endpoint is enabled for this location.
      items:
        $ref: '#/components/schemas/zero-trust-gateway_ip_network'
      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