APIs.io Engineering Platform Tunnel Virtual Network 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 Tunnel Virtual Network API
  version: 4.0.0
tags:
- name: Tunnel Virtual Network
paths:
  /accounts/{account_id}/teamnet/virtual_networks:
    get:
      description: Lists and filters virtual networks in an account.
      operationId: tunnel-virtual-network-list-virtual-networks
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      - in: query
        name: id
        schema:
          $ref: '#/components/schemas/tunnel_virtual_network_id'
      - in: query
        name: name
        schema:
          $ref: '#/components/schemas/tunnel_virtual_network_name'
      - in: query
        name: is_default
        schema:
          description: If `true`, only include the default virtual network. If `false`, exclude the default virtual network. If empty, all virtual networks will be included.
          type: boolean
      - in: query
        name: is_deleted
        schema:
          description: If `true`, only include deleted virtual networks. If `false`, exclude deleted virtual networks. If empty, all virtual networks will be included.
          type: boolean
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_vnet_response_collection'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: List virtual networks response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_vnet_response_collection'
          description: List virtual networks response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform List virtual networks
      tags:
      - Tunnel Virtual Network
      x-api-token-group:
      - Cloudflare One Networks Write
      - Cloudflare One Networks Read
      - Argo Tunnel Write
      - Argo Tunnel Read
    post:
      description: Adds a new virtual network to an account.
      operationId: tunnel-virtual-network-create-a-virtual-network
      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_virtual_network_comment'
                is_default:
                  $ref: '#/components/schemas/tunnel_is_default_network'
                name:
                  $ref: '#/components/schemas/tunnel_virtual_network_name'
              required:
              - name
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_vnet_response_single'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Create a virtual network response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_vnet_response_single'
          description: Create a virtual network response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform Create a virtual network
      tags:
      - Tunnel Virtual Network
      x-api-token-group:
      - Cloudflare One Networks Write
      - Argo Tunnel Write
  /accounts/{account_id}/teamnet/virtual_networks/{virtual_network_id}:
    delete:
      description: Deletes an existing virtual network.
      operationId: tunnel-virtual-network-delete
      parameters:
      - in: path
        name: virtual_network_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_virtual_network_id'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_vnet_response_single'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Delete a virtual network response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_vnet_response_single'
          description: Delete a virtual network response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform Delete a virtual network
      tags:
      - Tunnel Virtual Network
      x-api-token-group:
      - Cloudflare One Networks Write
      - Argo Tunnel Write
    get:
      description: Get a virtual network.
      operationId: tunnel-virtual-network-get
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      - in: path
        name: virtual_network_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_virtual_network_id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                comment:
                  $ref: '#/components/schemas/tunnel_virtual_network_comment'
                is_default_network:
                  $ref: '#/components/schemas/tunnel_is_default_network'
                name:
                  $ref: '#/components/schemas/tunnel_virtual_network_name'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_vnet_response_single'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: A virtual network response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_vnet_response_single'
          description: A virtual network response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform Get a virtual network
      tags:
      - Tunnel Virtual Network
    patch:
      description: Updates an existing virtual network.
      operationId: tunnel-virtual-network-update
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_account_id'
      - in: path
        name: virtual_network_id
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_virtual_network_id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                comment:
                  $ref: '#/components/schemas/tunnel_virtual_network_comment'
                is_default_network:
                  $ref: '#/components/schemas/tunnel_is_default_network'
                name:
                  $ref: '#/components/schemas/tunnel_virtual_network_name'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_vnet_response_single'
                - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Update a virtual network response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_vnet_response_single'
          description: Update a virtual network response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      - user_service_key: []
      summary: APIs.io Engineering Platform Update a virtual network
      tags:
      - Tunnel Virtual Network
      x-api-token-group:
      - Cloudflare One Networks Write
      - Argo Tunnel Write
components:
  schemas:
    tunnel_is_default_network:
      description: If `true`, this virtual network is the default for the account.
      example: true
      type: boolean
    tunnel_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    tunnel_virtual-network:
      properties:
        comment:
          $ref: '#/components/schemas/tunnel_virtual_network_comment'
        created_at:
          $ref: '#/components/schemas/tunnel_created_at'
        deleted_at:
          $ref: '#/components/schemas/tunnel_deleted_at'
        id:
          $ref: '#/components/schemas/tunnel_virtual_network_id'
        is_default_network:
          $ref: '#/components/schemas/tunnel_is_default_network'
        name:
          $ref: '#/components/schemas/tunnel_virtual_network_name'
      required:
      - id
      - name
      - is_default_network
      - comment
      - created_at
      type: object
    tunnel_virtual_network_id:
      description: UUID of the virtual network.
      example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415
      format: uuid
      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_virtual_network_comment:
      description: Optional remark describing the virtual network.
      example: Staging VPC for data science
      maxLength: 256
      type: string
    tunnel_created_at:
      description: Timestamp of when the resource was created.
      example: '2021-01-25T18:22:34.317854Z'
      format: date-time
      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
          type:
          - object
          - 'null'
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    tunnel_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/tunnel_api-response-common'
      - properties:
          result:
            items: {}
            type:
            - array
            - 'null'
          result_info:
            $ref: '#/components/schemas/tunnel_result_info'
      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_virtual_network_name:
      description: A user-friendly name for the virtual network.
      example: us-east-1-vpc
      maxLength: 256
      type: string
    tunnel_api-response-single:
      $ref: '#/components/schemas/tunnel_api-response-common'
    tunnel_account_id:
      description: Cloudflare account ID
      example: 699d98642c564d2e855e9661899b7252
      maxLength: 32
      type: string
    tunnel_vnet_response_single:
      allOf:
      - $ref: '#/components/schemas/tunnel_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/tunnel_virtual-network'
        type: object
    tunnel_vnet_response_collection:
      allOf:
      - $ref: '#/components/schemas/tunnel_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/tunnel_virtual-network'
            type: array
        type: object
    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
  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