openapi: 3.0.0
info:
  version: 2015-07-09
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Cloudflare Tunnel API
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: apigateway
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: https://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Cloudflare Tunnel
paths:
  /accounts/{account_id}/cfd_tunnel:
    get:
      description: Lists and filters Cloudflare Tunnels in an account.
      operationId: cloudflare-tunnel-list-cloudflare-tunnels
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      - in: query
        name: name
        schema:
          $ref: '#/components/schemas/tunnel_tunnel_name'
      - in: query
        name: is_deleted
        schema:
          description: If `true`, only include deleted tunnels. If `false`, exclude deleted tunnels. If empty, all tunnels will be included.
          example: true
          type: boolean
      - in: query
        name: existed_at
        schema:
          $ref: '#/components/schemas/tunnel_existed_at'
      - in: query
        name: uuid
        schema:
          $ref: '#/components/schemas/tunnel_tunnel_id'
      - in: query
        name: was_active_at
        schema:
          example: '2009-11-10T23:00:00Z'
          format: date-time
          type: string
      - in: query
        name: was_inactive_at
        schema:
          example: '2009-11-10T23:00:00Z'
          format: date-time
          type: string
      - in: query
        name: include_prefix
        schema:
          example: vpc1-
          type: string
      - in: query
        name: exclude_prefix
        schema:
          example: vpc1-
          type: string
      - in: query
        name: status
        schema:
          $ref: '#/components/schemas/tunnel_status'
      - in: query
        name: per_page
        schema:
          $ref: '#/components/schemas/tunnel_per_page'
      - in: query
        name: page
        schema:
          default: 1
          description: Page number of paginated results.
          minimum: 1
          type: number
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_tunnel-response-collection'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: List Cloudflare Tunnels response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel-response-collection'
          description: List Cloudflare Tunnels response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform List Cloudflare Tunnels
      tags:
      - Cloudflare Tunnel
      x-api-token-group:
      - Cloudflare One Connectors Write
      - Cloudflare One Connectors Read
      - Cloudflare One cloudflared Connectors Write
      - Cloudflare One cloudflared Connectors Read
      - Argo Tunnel Write
      - Argo Tunnel Read
    post:
      description: Creates a new Cloudflare Tunnel in an account.
      operationId: cloudflare-tunnel-create-a-cloudflare-tunnel
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                config_src:
                  $ref: '#/components/schemas/tunnel_config_src'
                name:
                  $ref: '#/components/schemas/tunnel_tunnel_name'
                tunnel_secret:
                  $ref: '#/components/schemas/tunnel_tunnel_secret'
              required:
              - name
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_tunnel-response-single'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Create a Cloudflare Tunnel response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel-response-single'
          description: Create a Cloudflare Tunnel response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform Create a Cloudflare Tunnel
      tags:
      - Cloudflare Tunnel
      x-api-token-group:
      - Cloudflare One Connectors Write
      - Cloudflare One cloudflared Connectors Write
      - Argo Tunnel Write
  /accounts/{account_id}/cfd_tunnel/{tunnel_id}:
    delete:
      description: Deletes a Cloudflare Tunnel from an account.
      operationId: cloudflare-tunnel-delete-a-cloudflare-tunnel
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      - in: path
        name: tunnel_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_tunnel_id'
      requestBody:
        content:
          application/json:
            schema:
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_tunnel-response-single'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Delete a Cloudflare Tunnel response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel-response-single'
          description: Delete a Cloudflare Tunnel response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform Delete a Cloudflare Tunnel
      tags:
      - Cloudflare Tunnel
      x-api-token-group:
      - Cloudflare One Connectors Write
      - Cloudflare One cloudflared Connectors Write
      - Argo Tunnel Write
    get:
      description: Fetches a single Cloudflare Tunnel.
      operationId: cloudflare-tunnel-get-a-cloudflare-tunnel
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      - in: path
        name: tunnel_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_tunnel_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_tunnel-response-single'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Get a Cloudflare Tunnel response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel-response-single'
          description: Get a Cloudflare Tunnel response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform Get a Cloudflare Tunnel
      tags:
      - Cloudflare Tunnel
      x-api-token-group:
      - Cloudflare One Connectors Write
      - Cloudflare One Connectors Read
      - Cloudflare One cloudflared Connectors Write
      - Cloudflare One cloudflared Connectors Read
      - Argo Tunnel Write
      - Argo Tunnel Read
    patch:
      description: Updates an existing Cloudflare Tunnel.
      operationId: cloudflare-tunnel-update-a-cloudflare-tunnel
      parameters:
      - in: path
        name: tunnel_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_tunnel_id'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  $ref: '#/components/schemas/tunnel_tunnel_name'
                tunnel_secret:
                  $ref: '#/components/schemas/tunnel_tunnel_secret'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_tunnel-response-single'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Update a Cloudflare Tunnel response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel-response-single'
          description: Update a Cloudflare Tunnel response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform Update a Cloudflare Tunnel
      tags:
      - Cloudflare Tunnel
      x-api-token-group:
      - Cloudflare One Connectors Write
      - Cloudflare One cloudflared Connectors Write
      - Argo Tunnel Write
  /accounts/{account_id}/cfd_tunnel/{tunnel_id}/connections:
    delete:
      description: Removes a connection (aka Cloudflare Tunnel Connector) from a Cloudflare Tunnel independently of its current state. If no connector id (client_id) is provided all connectors will be removed. We recommend running this command after rotating tokens.
      operationId: cloudflare-tunnel-clean-up-cloudflare-tunnel-connections
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      - in: path
        name: tunnel_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_tunnel_id'
      - in: query
        name: client_id
        schema:
          $ref: '#/components/schemas/tunnel_client_id'
      requestBody:
        content:
          application/json:
            schema:
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_empty_response'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Clean up Cloudflare Tunnel connections response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_empty_response'
          description: Clean up Cloudflare Tunnel connections response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform Clean up Cloudflare Tunnel connections
      tags:
      - Cloudflare Tunnel
    get:
      description: Fetches connection details for a Cloudflare Tunnel.
      operationId: cloudflare-tunnel-list-cloudflare-tunnel-connections
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      - in: path
        name: tunnel_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_tunnel_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_tunnel_connections_response'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: List Cloudflare Tunnel connections response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel_connections_response'
          description: List Cloudflare Tunnel connections response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform List Cloudflare Tunnel connections
      tags:
      - Cloudflare Tunnel
  /accounts/{account_id}/cfd_tunnel/{tunnel_id}/connectors/{connector_id}:
    get:
      description: Fetches connector and connection details for a Cloudflare Tunnel.
      operationId: cloudflare-tunnel-get-cloudflare-tunnel-connector
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      - in: path
        name: tunnel_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_tunnel_id'
      - in: path
        name: connector_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_client_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_tunnel_client_response'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Get Cloudflare Tunnel connector response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel_client_response'
          description: Get Cloudflare Tunnel connector response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform Get Cloudflare Tunnel connector
      tags:
      - Cloudflare Tunnel
  /accounts/{account_id}/cfd_tunnel/{tunnel_id}/management:
    post:
      description: Gets a management token used to access the management resources (i.e. Streaming Logs) of a tunnel.
      operationId: cloudflare-tunnel-get-a-cloudflare-tunnel-management-token
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      - in: path
        name: tunnel_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_tunnel_id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                resources:
                  items:
                    $ref: '#/components/schemas/tunnel_management-resources'
                  type: array
              required:
              - resources
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_tunnel_response_token'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Cloudflare API response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel_response_token'
          description: Get a Cloudflare Tunnel management token response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform Get a Cloudflare Tunnel management token
      tags:
      - Cloudflare Tunnel
  /accounts/{account_id}/cfd_tunnel/{tunnel_id}/token:
    get:
      description: Gets the token used to associate cloudflared with a specific tunnel.
      operationId: cloudflare-tunnel-get-a-cloudflare-tunnel-token
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      - in: path
        name: tunnel_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_tunnel_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_tunnel_response_token'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Get a Cloudflare Tunnel token response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel_response_token'
          description: Get a Cloudflare Tunnel token response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform Get a Cloudflare Tunnel token
      tags:
      - Cloudflare Tunnel
  /accounts/{account_id}/tunnels:
    get:
      description: Lists and filters all types of Tunnels in an account.
      operationId: cloudflare-tunnel-list-all-tunnels
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      - in: query
        name: name
        schema:
          description: A user-friendly name for the tunnel.
          example: blog
          type: string
      - in: query
        name: is_deleted
        schema:
          description: If `true`, only include deleted tunnels. If `false`, exclude deleted tunnels. If empty, all tunnels will be included.
          example: true
          type: boolean
      - in: query
        name: existed_at
        schema:
          $ref: '#/components/schemas/tunnel_existed_at'
      - in: query
        name: uuid
        schema:
          $ref: '#/components/schemas/tunnel_tunnel_id'
      - in: query
        name: was_active_at
        schema:
          example: '2009-11-10T23:00:00Z'
          format: date-time
          type: string
      - in: query
        name: was_inactive_at
        schema:
          example: '2009-11-10T23:00:00Z'
          format: date-time
          type: string
      - in: query
        name: include_prefix
        schema:
          example: vpc1-
          type: string
      - in: query
        name: exclude_prefix
        schema:
          example: vpc1-
          type: string
      - in: query
        name: tun_types
        schema:
          $ref: '#/components/schemas/tunnel_tunnel_types'
      - in: query
        name: status
        schema:
          $ref: '#/components/schemas/tunnel_status'
      - in: query
        name: per_page
        schema:
          $ref: '#/components/schemas/tunnel_per_page'
      - in: query
        name: page
        schema:
          default: 1
          description: Page number of paginated results.
          minimum: 1
          type: number
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_tunnel-response-collection'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: List Tunnels response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel-response-collection'
          description: List Tunnels response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform List All Tunnels
      tags:
      - Cloudflare Tunnel
      x-api-token-group:
      - Cloudflare One Connectors Write
      - Cloudflare One Connectors Read
      - Cloudflare One cloudflared Connectors Write
      - Cloudflare One cloudflared Connectors Read
      - Argo Tunnel Write
      - Argo Tunnel Read
  /accounts/{account_id}/warp_connector:
    get:
      description: Lists and filters Warp Connector Tunnels in an account.
      operationId: cloudflare-tunnel-list-warp-connector-tunnels
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      - in: query
        name: name
        schema:
          description: A user-friendly name for the tunnel.
          example: blog
          type: string
      - in: query
        name: is_deleted
        schema:
          description: If `true`, only include deleted tunnels. If `false`, exclude deleted tunnels. If empty, all tunnels will be included.
          example: true
          type: boolean
      - in: query
        name: existed_at
        schema:
          $ref: '#/components/schemas/tunnel_existed_at'
      - in: query
        name: uuid
        schema:
          $ref: '#/components/schemas/tunnel_tunnel_id'
      - in: query
        name: was_active_at
        schema:
          example: '2009-11-10T23:00:00Z'
          format: date-time
          type: string
      - in: query
        name: was_inactive_at
        schema:
          example: '2009-11-10T23:00:00Z'
          format: date-time
          type: string
      - in: query
        name: include_prefix
        schema:
          example: vpc1-
          type: string
      - in: query
        name: exclude_prefix
        schema:
          example: vpc1-
          type: string
      - in: query
        name: status
        schema:
          $ref: '#/components/schemas/tunnel_status'
      - in: query
        name: per_page
        schema:
          $ref: '#/components/schemas/tunnel_per_page'
      - in: query
        name: page
        schema:
          default: 1
          description: Page number of paginated results.
          minimum: 1
          type: number
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_tunnel-response-collection'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: List Warp Connector Tunnels response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel-response-collection'
          description: List Warp Connector Tunnels response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform List Warp Connector Tunnels
      tags:
      - Cloudflare Tunnel
      x-api-token-group:
      - Cloudflare One Connectors Write
      - Cloudflare One Connectors Read
      - Cloudflare One Warp Connectors Write
      - Cloudflare One Warp Connectors Read
    post:
      description: Creates a new Warp Connector Tunnel in an account.
      operationId: cloudflare-tunnel-create-a-warp-connector-tunnel
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  $ref: '#/components/schemas/tunnel_tunnel_name'
              required:
              - name
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_tunnel-response-single'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Create a Warp Connector Tunnel response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel-response-single'
          description: Create a Warp Connector Tunnel response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform Create a Warp Connector Tunnel
      tags:
      - Cloudflare Tunnel
      x-api-token-group:
      - Cloudflare One Connectors Write
      - Cloudflare One Warp Connectors Write
  /accounts/{account_id}/warp_connector/{tunnel_id}:
    delete:
      description: Deletes a Warp Connector Tunnel from an account.
      operationId: cloudflare-tunnel-delete-a-warp-connector-tunnel
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      - in: path
        name: tunnel_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_tunnel_id'
      requestBody:
        content:
          application/json:
            schema:
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_tunnel-response-single'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Delete a Warp Connector Tunnel response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel-response-single'
          description: Delete a Warp Connector Tunnel response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform Delete a Warp Connector Tunnel
      tags:
      - Cloudflare Tunnel
      x-api-token-group:
      - Cloudflare One Connectors Write
      - Cloudflare One Warp Connectors Write
    get:
      description: Fetches a single Warp Connector Tunnel.
      operationId: cloudflare-tunnel-get-a-warp-connector-tunnel
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      - in: path
        name: tunnel_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_tunnel_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_tunnel-response-single'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Get a Warp Connector Tunnel response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel-response-single'
          description: Get a Warp Connector Tunnel response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform Get a Warp Connector Tunnel
      tags:
      - Cloudflare Tunnel
      x-api-token-group:
      - Cloudflare One Connectors Write
      - Cloudflare One Connectors Read
      - Cloudflare One Warp Connectors Write
      - Cloudflare One Warp Connectors Read
    patch:
      description: Updates an existing Warp Connector Tunnel.
      operationId: cloudflare-tunnel-update-a-warp-connector-tunnel
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      - in: path
        name: tunnel_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_tunnel_id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  $ref: '#/components/schemas/tunnel_tunnel_name'
                tunnel_secret:
                  $ref: '#/components/schemas/tunnel_tunnel_secret'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_tunnel-response-single'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Update a Warp Connector Tunnel response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel-response-single'
          description: Update a Warp Connector Tunnel response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform Update a Warp Connector Tunnel
      tags:
      - Cloudflare Tunnel
      x-api-token-group:
      - Cloudflare One Connectors Write
      - Cloudflare One Warp Connectors Write
  /accounts/{account_id}/warp_connector/{tunnel_id}/token:
    get:
      description: Gets the token used to associate warp device with a specific Warp Connector tunnel.
      operationId: cloudflare-tunnel-get-a-warp-connector-tunnel-token
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      - in: path
        name: tunnel_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_tunnel_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_tunnel_response_token'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Get a Warp Connector Tunnel token response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel_response_token'
          description: Get a Warp Connector Tunnel token response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform Get a Warp Connector Tunnel token
      tags:
      - Cloudflare Tunnel
components:
  schemas:
    tunnel_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
    tunnel_cfd_tunnel:
      description: A Cloudflare Tunnel that connects your origin to Cloudflare's edge.
      properties:
        account_tag:
          $ref: '#/components/schemas/tunnel_account_id'
        connections:
          $ref: '#/components/schemas/tunnel_connections'
        conns_active_at:
          $ref: '#/components/schemas/tunnel_conns_active_at'
        conns_inactive_at:
          $ref: '#/components/schemas/tunnel_conns_inactive_at'
        created_at:
          $ref: '#/components/schemas/tunnel_created_at'
        deleted_at:
          $ref: '#/components/schemas/tunnel_deleted_at'
        id:
          $ref: '#/components/schemas/tunnel_tunnel_id'
        metadata:
          $ref: '#/components/schemas/tunnel_metadata'
        name:
          $ref: '#/components/schemas/tunnel_tunnel_name'
        remote_config:
          $ref: '#/components/schemas/tunnel_remote_config'
        status:
          $ref: '#/components/schemas/tunnel_status'
        tun_type:
          $ref: '#/components/schemas/tunnel_tunnel_type'
      type: object
    tunnel_run_at:
      description: Timestamp of when the tunnel connection was started.
      example: '2009-11-10T23:00:00Z'
      format: date-time
      type: string
    tunnel_status:
      description: The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).
      enum:
      - inactive
      - degraded
      - healthy
      - down
      example: healthy
      type: string
    tunnel_account_id:
      description: Cloudflare account ID
      example: 699d98642c564d2e855e9661899b7252
      maxLength: 32
      type: string
    tunnel_version:
      description: The cloudflared version used to establish this connection.
      example: 2022.7.1
      type: string
    tunnel_tunnel_types:
      description: The types of tunnels to filter separated by a comma.
      example: cfd_tunnel,warp_connector
      type: string
    tunnel_metadata:
      description: Metadata associated with the tunnel.
      example: {}
      type: object
    tunnel_features:
      description: Features enabled for the Cloudflare Tunnel.
      items:
        example: ha-origin
        type: string
      type: array
    tunnel_existed_at:
      description: If provided, include only tunnels that were created (and not deleted) before this time.
      example: '2019-10-12T07:20:50.52Z'
      format: date-time
      type: string
    tunnel_api-response-single:
      $ref: '#/components/schemas/tunnel_api-response-common'
    tunnel_remote_config:
      description: If `true`, the tunnel can be configured remotely from the Zero Trust dashboard. If `false`, the tunnel must be configured locally on the origin machine.
      example: true
      type: boolean
    tunnel_client_id:
      description: UUID of the Cloudflare Tunnel connector.
      example: 1bedc50d-42b3-473c-b108-ff3d10c0d925
      format: uuid
      maxLength: 36
      readOnly: true
      type: string
    tunnel_schemas-connection:
      properties:
        client_id:
          $ref: '#/components/schemas/tunnel_client_id'
        client_version:
          $ref: '#/components/schemas/tunnel_version'
        colo_name:
          $ref: '#/components/schemas/tunnel_colo_name'
        id:
          $ref: '#/components/schemas/tunnel_connection_id'
        is_pending_reconnect:
          $ref: '#/components/schemas/tunnel_is_pending_reconnect'
        opened_at:
          description: Timestamp of when the connection was established.
          example: '2021-01-25T18:22:34.317854Z'
          format: date-time
          type: string
        origin_ip:
          allOf:
          - $ref: '#/components/schemas/tunnel_ip'
          description: The public IP address of the host running cloudflared.
        uuid:
          $ref: '#/components/schemas/tunnel_connection_id'
    tunnel_per_page:
      description: Number of results to display.
      maximum: 1000
      minimum: 1
      type: number
    tunnel_config_version:
      description: The version of the remote tunnel configuration. Used internally to sync cloudflared with the Zero Trust dashboard.
      type: integer
    tunnel_tunnel_client:
      description: A client (typically cloudflared) that maintains connections to a Cloudflare data center.
      properties:
        arch:
          $ref: '#/components/schemas/tunnel_arch'
        config_version:
          $ref: '#/components/schemas/tunnel_config_version'
        conns:
          $ref: '#/components/schemas/tunnel_connections'
        features:
          $ref: '#/components/schemas/tunnel_features'
        id:
          $ref: '#/components/schemas/tunnel_connection_id'
        run_at:
          $ref: '#/components/schemas/tunnel_run_at'
        version:
          $ref: '#/components/schemas/tunnel_version'
      type: object
    tunnel_tunnel_connections_response:
      allOf:
      - $ref: '#/components/schemas/tunnel_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/tunnel_tunnel_client'
            type: array
        type: object
    tunnel_warp_connector_tunnel:
      description: A Warp Connector Tunnel that connects your origin to Cloudflare's edge.
      properties:
        account_tag:
          $ref: '#/components/schemas/tunnel_account_id'
        connections:
          $ref: '#/components/schemas/tunnel_connections'
        conns_active_at:
          $ref: '#/components/schemas/tunnel_conns_active_at'
        conns_inactive_at:
          $ref: '#/components/schemas/tunnel_conns_inactive_at'
        created_at:
          $ref: '#/components/schemas/tunnel_created_at'
        deleted_at:
          $ref: '#/components/schemas/tunnel_deleted_at'
        id:
          $ref: '#/components/schemas/tunnel_tunnel_id'
        metadata:
          $ref: '#/components/schemas/tunnel_metadata'
        name:
          $ref: '#/components/schemas/tunnel_tunnel_name'
        status:
          $ref: '#/components/schemas/tunnel_status'
        tun_type:
          $ref: '#/components/schemas/tunnel_tunnel_type'
      type: object
    tunnel_management-resources:
      description: Management resources the token will have access to.
      enum:
      - logs
      example: logs
      type: string
    tunnel_is_pending_reconnect:
      description: Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting.  If `true`, the connection has disconnected but is still being tracked. If `false`, the connection is actively serving traffic.
      example: false
      type: boolean
    tunnel_colo_name:
      description: The Cloudflare data center used for this connection.
      example: DFW
      type: string
    tunnel_tunnel_client_response:
      allOf:
      - $ref: '#/components/schemas/tunnel_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/tunnel_tunnel_client'
        type: object
    tunnel_ip:
      example: 10.1.0.137
      type: string
    tunnel_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/tunnel_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/tunnel_messages'
          example: []
        result:
          enum:
          - null
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    tunnel_conns_inactive_at:
      description: Timestamp of when the tunnel became inactive (no connections to Cloudflare's edge). If `null`, the tunnel is active.
      example: '2009-11-10T23:00:00Z'
      format: date-time
      type: string
    tunnel_config_src:
      default: local
      description: Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard.
      enum:
      - local
      - cloudflare
      example: cloudflare
      type: string
    tunnel_conns_active_at:
      description: Timestamp of when the tunnel established at least one connection to Cloudflare's edge. If `null`, the tunnel is inactive.
      example: '2009-11-10T23:00:00Z'
      format: date-time
      type: string
    tunnel_connections:
      description: The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
      items:
        $ref: '#/components/schemas/tunnel_schemas-connection'
      type: array
    tunnel_arch:
      description: The cloudflared OS architecture used to establish this connection.
      example: linux_amd64
      type: string
    tunnel_tunnel_secret:
      description: Sets the password required to run a locally-managed tunnel. Must be at least 32 bytes and encoded as a base64 string.
      example: AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg=
      type: string
    tunnel_deleted_at:
      description: Timestamp of when the resource was deleted. If `null`, the resource has not been deleted.
      example: '2009-11-10T23:00:00Z'
      format: date-time
      type: string
    tunnel_connection_id:
      description: UUID of the Cloudflare Tunnel connection.
      example: 1bedc50d-42b3-473c-b108-ff3d10c0d925
      format: uuid
      maxLength: 36
      readOnly: true
      type: string
    tunnel_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    tunnel_empty_response:
      allOf:
      - $ref: '#/components/schemas/tunnel_api-response-common'
      - properties:
          result:
            enum:
            - null
            nullable: true
            type: object
        type: object
    tunnel_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/tunnel_messages'
        messages:
          $ref: '#/components/schemas/tunnel_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
    tunnel_tunnel_id:
      description: UUID of the tunnel.
      example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415
      format: uuid
      maxLength: 36
      readOnly: true
      type: string
    tunnel_tunnel_name:
      description: A user-friendly name for a tunnel.
      example: blog
      type: string
    tunnel_tunnel_type:
      description: The type of tunnel.
      enum:
      - cfd_tunnel
      - warp_connector
      - ip_sec
      - gre
      - cni
      example: cfd_tunnel
      type: string
    tunnel_tunnel_response_token:
      allOf:
      - $ref: '#/components/schemas/tunnel_api-response-single'
      - properties:
          result:
            example: eyJhIjoiNWFiNGU5Z...
            type: string
        type: object
    tunnel_tunnel-response-single:
      allOf:
      - $ref: '#/components/schemas/tunnel_api-response-single'
      - properties:
          result:
            anyOf:
            - $ref: '#/components/schemas/tunnel_cfd_tunnel'
            - $ref: '#/components/schemas/tunnel_warp_connector_tunnel'
        type: object
    tunnel_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/tunnel_api-response-common'
      - properties:
          result:
            items: {}
            nullable: true
            type: array
          result_info:
            $ref: '#/components/schemas/tunnel_result_info'
      type: object
    tunnel_tunnel-response-collection:
      allOf:
      - $ref: '#/components/schemas/tunnel_api-response-collection'
      - properties:
          result:
            items:
              anyOf:
              - $ref: '#/components/schemas/tunnel_cfd_tunnel'
              - $ref: '#/components/schemas/tunnel_warp_connector_tunnel'
            type: array
        type: object
    tunnel_created_at:
      description: Timestamp of when the resource was created.
      example: '2021-01-25T18:22:34.317854Z'
      format: date-time
      type: string
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/apigateway/
x-hasEquivalentPaths: true