APIs.io Engineering Platform Tunnel Routing API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Tunnel Routing 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
    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: Tunnel Routing
paths:
  /accounts/{account_id}/teamnet/routes:
    get:
      description: Lists and filters private network routes in an account.
      operationId: tunnel-route-list-tunnel-routes
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      - in: query
        name: comment
        schema:
          $ref: '#/components/schemas/tunnel_comment'
      - in: query
        name: is_deleted
        schema:
          description: If `true`, only include deleted routes. If `false`, exclude deleted routes. If empty, all routes will be included.
          type: boolean
      - in: query
        name: network_subset
        schema:
          allOf:
          - $ref: '#/components/schemas/tunnel_ip_network'
          description: If set, only list routes that are contained within this IP range.
      - in: query
        name: network_superset
        schema:
          allOf:
          - $ref: '#/components/schemas/tunnel_ip_network'
          description: If set, only list routes that contain this IP range.
      - in: query
        name: existed_at
        schema:
          $ref: '#/components/schemas/tunnel_existed_at'
      - in: query
        name: tunnel_id
        schema:
          $ref: '#/components/schemas/tunnel_tunnel_id'
      - in: query
        name: route_id
        schema:
          $ref: '#/components/schemas/tunnel_route_id'
      - in: query
        name: tun_types
        schema:
          $ref: '#/components/schemas/tunnel_tunnel_types'
      - in: query
        name: virtual_network_id
        schema:
          $ref: '#/components/schemas/tunnel_virtual_network_id'
      - 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_teamnet_response_collection'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: List tunnel routes response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_teamnet_response_collection'
          description: List tunnel routes response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform List tunnel routes
      tags:
      - Tunnel Routing
      x-api-token-group:
      - Cloudflare One Networks Write
      - Cloudflare One Networks Read
      - Argo Tunnel Write
      - Argo Tunnel Read
    post:
      description: Routes a private network through a Cloudflare Tunnel.
      operationId: tunnel-route-create-a-tunnel-route
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                comment:
                  $ref: '#/components/schemas/tunnel_comment'
                network:
                  $ref: '#/components/schemas/tunnel_ip_network'
                tunnel_id:
                  $ref: '#/components/schemas/tunnel_tunnel_id'
                virtual_network_id:
                  $ref: '#/components/schemas/tunnel_virtual_network_id'
              required:
              - network
              - tunnel_id
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_route_response_single'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Create a tunnel route response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_route_response_single'
          description: Create a tunnel route response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform Create a tunnel route
      tags:
      - Tunnel Routing
      x-api-token-group:
      - Cloudflare One Networks Write
      - Argo Tunnel Write
  /accounts/{account_id}/teamnet/routes/{route_id}:
    delete:
      description: 'Deletes a private network route from an account.

        '
      operationId: tunnel-route-delete-a-tunnel-route
      parameters:
      - in: path
        name: route_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_route_id'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_route_response_single'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Delete a tunnel route response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_route_response_single'
          description: Delete a tunnel route response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform Delete a tunnel route
      tags:
      - Tunnel Routing
      x-api-token-group:
      - Cloudflare One Networks Write
      - Argo Tunnel Write
    get:
      description: Get a private network route in an account.
      operationId: tunnel-route-get-tunnel-route
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      - in: path
        name: route_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_route_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_route_response_single'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Get a tunnel route response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_route_response_single'
          description: Get a tunnel route response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform Get tunnel route
      tags:
      - Tunnel Routing
    patch:
      description: Updates an existing private network route in an account. The fields that are meant to be updated should be provided in the body of the request.
      operationId: tunnel-route-update-a-tunnel-route
      parameters:
      - in: path
        name: route_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_route_id'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                comment:
                  $ref: '#/components/schemas/tunnel_comment'
                network:
                  $ref: '#/components/schemas/tunnel_ip_network'
                tunnel_id:
                  $ref: '#/components/schemas/tunnel_tunnel_id'
                virtual_network_id:
                  $ref: '#/components/schemas/tunnel_virtual_network_id'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_route_response_single'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Update a tunnel route response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_route_response_single'
          description: Update a tunnel route response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform Update a tunnel route
      tags:
      - Tunnel Routing
      x-api-token-group:
      - Cloudflare One Networks Write
      - Argo Tunnel Write
  /accounts/{account_id}/teamnet/routes/ip/{ip}:
    get:
      description: Fetches routes that contain the given IP address.
      operationId: tunnel-route-get-tunnel-route-by-ip
      parameters:
      - in: path
        name: ip
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_ip'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      - in: query
        name: virtual_network_id
        schema:
          $ref: '#/components/schemas/tunnel_virtual_network_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_teamnet_response_single'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Get tunnel route by IP response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_teamnet_response_single'
          description: Get tunnel route by IP response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform Get tunnel route by IP
      tags:
      - Tunnel Routing
  /accounts/{account_id}/teamnet/routes/network/{ip_network_encoded}:
    delete:
      deprecated: true
      description: 'Deletes a private network route from an account. The CIDR in `ip_network_encoded` must be written in URL-encoded format. If no virtual_network_id is provided it will delete the route from the default vnet. If no tun_type is provided it will fetch the type from the tunnel_id or if that is missing it will assume Cloudflare Tunnel as default. If tunnel_id is provided it will delete the route from that tunnel, otherwise it will delete the route based on the vnet and tun_type.

        '
      operationId: tunnel-route-delete-a-tunnel-route-with-cidr
      parameters:
      - in: path
        name: ip_network_encoded
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_ip_network_encoded'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      - in: query
        name: virtual_network_id
        schema:
          $ref: '#/components/schemas/tunnel_virtual_network_id'
      - in: query
        name: tun_type
        schema:
          $ref: '#/components/schemas/tunnel_tunnel_type'
      - in: query
        name: tunnel_id
        schema:
          $ref: '#/components/schemas/tunnel_tunnel_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_route_response_single'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Delete a tunnel route response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_route_response_single'
          description: Delete a tunnel route response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform Delete a tunnel route (CIDR Endpoint)
      tags:
      - Tunnel Routing
      x-api-token-group:
      - Cloudflare One Networks Write
      - Argo Tunnel Write
      x-cfDeprecation:
        description: This endpoint and its related APIs are deprecated in favor of the equivalent Tunnel Route (without CIDR) APIs.
        display: true
        eol: '2025-09-30'
        id: teamnet_routes_with_cidr_deprecation
    patch:
      deprecated: true
      description: Updates an existing private network route in an account. The CIDR in `ip_network_encoded` must be written in URL-encoded format.
      operationId: tunnel-route-update-a-tunnel-route-with-cidr
      parameters:
      - in: path
        name: ip_network_encoded
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_ip_network_encoded'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_route_response_single'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Update a tunnel route response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_route_response_single'
          description: Update a tunnel route response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform Update a tunnel route (CIDR Endpoint)
      tags:
      - Tunnel Routing
      x-api-token-group:
      - Cloudflare One Networks Write
      - Argo Tunnel Write
      x-cfDeprecation:
        description: This endpoint and its related APIs are deprecated in favor of the equivalent Tunnel Route (without CIDR) APIs.
        display: true
        eol: '2025-09-30'
        id: teamnet_routes_with_cidr_deprecation
    post:
      deprecated: true
      description: Routes a private network through a Cloudflare Tunnel. The CIDR in `ip_network_encoded` must be written in URL-encoded format.
      operationId: tunnel-route-create-a-tunnel-route-with-cidr
      parameters:
      - in: path
        name: ip_network_encoded
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_ip_network_encoded'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                comment:
                  $ref: '#/components/schemas/tunnel_comment'
                tunnel_id:
                  $ref: '#/components/schemas/tunnel_tunnel_id'
                virtual_network_id:
                  $ref: '#/components/schemas/tunnel_virtual_network_id'
              required:
              - tunnel_id
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_route_response_single'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Create a tunnel route response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_route_response_single'
          description: Create a tunnel route response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform Create a tunnel route (CIDR Endpoint)
      tags:
      - Tunnel Routing
      x-api-token-group:
      - Cloudflare One Networks Write
      - Argo Tunnel Write
      x-cfDeprecation:
        description: This endpoint and its related APIs are deprecated in favor of the equivalent Tunnel Route (without CIDR) APIs.
        display: true
        eol: '2025-09-30'
        id: teamnet_routes_with_cidr_deprecation
components:
  schemas:
    tunnel_account_id:
      description: Cloudflare account ID
      example: 699d98642c564d2e855e9661899b7252
      maxLength: 32
      type: string
    tunnel_ip_network:
      description: The private IPv4 or IPv6 range connected by the route, in CIDR notation.
      example: 172.16.0.0/16
      type: string
    tunnel_route_response_single:
      allOf:
      - $ref: '#/components/schemas/tunnel_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/tunnel_route'
        type: object
    tunnel_tunnel_types:
      description: The types of tunnels to filter separated by a comma.
      example: cfd_tunnel,warp_connector
      type: string
    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_teamnet_response_single:
      allOf:
      - $ref: '#/components/schemas/tunnel_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/tunnel_teamnet'
        type: object
    tunnel_per_page:
      description: Number of results to display.
      maximum: 1000
      minimum: 1
      type: number
    tunnel_route_id:
      description: UUID of the route.
      example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      readOnly: true
      type: string
    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_route:
      properties:
        comment:
          $ref: '#/components/schemas/tunnel_comment'
        created_at:
          $ref: '#/components/schemas/tunnel_created_at'
        deleted_at:
          $ref: '#/components/schemas/tunnel_deleted_at'
        id:
          $ref: '#/components/schemas/tunnel_route_id'
        network:
          $ref: '#/components/schemas/tunnel_ip_network'
        tunnel_id:
          $ref: '#/components/schemas/tunnel_tunnel_id'
        virtual_network_id:
          $ref: '#/components/schemas/tunnel_virtual_network_id'
      type: object
    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_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    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_virtual_network_name:
      description: A user-friendly name for the virtual network.
      example: us-east-1-vpc
      maxLength: 256
      type: string
    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_teamnet:
      properties:
        comment:
          $ref: '#/components/schemas/tunnel_comment'
        created_at:
          $ref: '#/components/schemas/tunnel_created_at'
        deleted_at:
          $ref: '#/components/schemas/tunnel_deleted_at'
        id:
          $ref: '#/components/schemas/tunnel_route_id'
        network:
          $ref: '#/components/schemas/tunnel_ip_network'
        tun_type:
          $ref: '#/components/schemas/tunnel_tunnel_type'
        tunnel_id:
          $ref: '#/components/schemas/tunnel_tunnel_id'
        tunnel_name:
          $ref: '#/components/schemas/tunnel_tunnel_name'
        virtual_network_id:
          $ref: '#/components/schemas/tunnel_virtual_network_id'
        virtual_network_name:
          $ref: '#/components/schemas/tunnel_virtual_network_name'
      type: object
    tunnel_virtual_network_id:
      description: UUID of the virtual network.
      example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415
      format: uuid
      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_teamnet_response_collection:
      allOf:
      - $ref: '#/components/schemas/tunnel_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/tunnel_teamnet'
            type: array
        type: object
    tunnel_ip_network_encoded:
      description: IP/CIDR range in URL-encoded format
      example: 172.16.0.0%2F16
      type: string
    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_comment:
      description: Optional remark describing the route.
      example: Example comment for this route.
      type: string
    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_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