APIs.io Engineering Platform Zero Trust Gateway Proxy Endpoints 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 Proxy Endpoints API
  version: 4.0.0
tags:
- name: Zero Trust Gateway Proxy Endpoints
paths:
  /accounts/{account_id}/gateway/proxy_endpoints:
    get:
      description: Fetches all Zero Trust Gateway proxy endpoints for an account.
      operationId: zero-trust-gateway-proxy-endpoints-list-proxy-endpoints
      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_proxy-endpoints_components-schemas-single_response'
                - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: List proxy endpoints response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response'
          description: List proxy endpoints response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List proxy endpoints
      tags:
      - Zero Trust Gateway Proxy Endpoints
    post:
      description: Creates a new Zero Trust Gateway proxy endpoint.
      operationId: zero-trust-gateway-proxy-endpoints-create-proxy-endpoint
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                ips:
                  $ref: '#/components/schemas/zero-trust-gateway_ips'
                name:
                  $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-name'
              required:
              - name
              - ips
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response'
                - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Create a proxy endpoint response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response'
          description: Create a proxy endpoint response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create a proxy endpoint
      tags:
      - Zero Trust Gateway Proxy Endpoints
  /accounts/{account_id}/gateway/proxy_endpoints/{proxy_endpoint_id}:
    delete:
      description: Deletes a configured Zero Trust Gateway proxy endpoint.
      operationId: zero-trust-gateway-proxy-endpoints-delete-proxy-endpoint
      parameters:
      - in: path
        name: proxy_endpoint_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 proxy endpoint response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_empty_response'
          description: Delete a proxy endpoint response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete a proxy endpoint
      tags:
      - Zero Trust Gateway Proxy Endpoints
    get:
      description: Fetches a single Zero Trust Gateway proxy endpoint.
      operationId: zero-trust-gateway-proxy-endpoints-proxy-endpoint-details
      parameters:
      - in: path
        name: proxy_endpoint_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_proxy-endpoints_components-schemas-response_collection'
                - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Get a proxy endpoint response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-response_collection'
          description: Get a proxy endpoint response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get a proxy endpoint
      tags:
      - Zero Trust Gateway Proxy Endpoints
    patch:
      description: Updates a configured Zero Trust Gateway proxy endpoint.
      operationId: zero-trust-gateway-proxy-endpoints-update-proxy-endpoint
      parameters:
      - in: path
        name: proxy_endpoint_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:
                ips:
                  $ref: '#/components/schemas/zero-trust-gateway_ips'
                name:
                  $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-name'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response'
                - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Update a proxy endpoint response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response'
          description: Update a proxy endpoint response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update a proxy endpoint
      tags:
      - Zero Trust Gateway Proxy Endpoints
components:
  schemas:
    zero-trust-gateway_components-schemas-uuid:
      example: ed35569b41ce4d1facfe683550f54086
      type: string
    zero-trust-gateway_proxy-endpoints_components-schemas-name:
      description: The name of the proxy endpoint.
      example: Devops team
      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_schemas-subdomain:
      description: The subdomain to be used as the destination in the proxy client.
      example: oli3n9zkz5.proxy.cloudflare-gateway.com
      type: string
    zero-trust-gateway_proxy-endpoints_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/zero-trust-gateway_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints'
            type: array
    zero-trust-gateway_proxy-endpoints_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints'
    zero-trust-gateway_ips:
      description: A list of CIDRs to restrict ingress connections.
      items:
        description: The IPv4 CIDR or IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /109. IPv4 CIDRs are limited to a maximum of /25.
        example: 192.0.2.1/32
        type: string
      type: array
    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_proxy-endpoints:
      properties:
        created_at:
          $ref: '#/components/schemas/zero-trust-gateway_timestamp'
        id:
          $ref: '#/components/schemas/zero-trust-gateway_components-schemas-uuid'
        ips:
          $ref: '#/components/schemas/zero-trust-gateway_ips'
        name:
          $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-name'
        subdomain:
          $ref: '#/components/schemas/zero-trust-gateway_schemas-subdomain'
        updated_at:
          $ref: '#/components/schemas/zero-trust-gateway_timestamp'
      type: object
    zero-trust-gateway_api-response-single:
      allOf:
      - $ref: '#/components/schemas/zero-trust-gateway_api-response-common'
      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_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_empty_response:
      allOf:
      - $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
      - properties:
          result:
            type: object
    zero-trust-gateway_identifier:
      example: 699d98642c564d2e855e9661899b7252
      type: string
  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