Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Tunnel Virtual Network API

The Tunnel Virtual Network API from APIs.io Engineering Platform — 2 operation(s) for tunnel virtual network.

This API exposes 5 operations across 2 paths, and defines 16 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

5 operations 2 paths 16 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Tunnel Virtual Network API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Tunnel Virtual Network 5
GET
/accounts/{account_id}/teamnet/virtual_networks
APIs.io Engineering Platform List virtual networks
tunnel-virtual-network-list-virtual-networks 5 params → 4XX200
POST
/accounts/{account_id}/teamnet/virtual_networks
APIs.io Engineering Platform Create a virtual network
tunnel-virtual-network-create-a-virtual-network 1 param body → 4XX200
DELETE
/accounts/{account_id}/teamnet/virtual_networks/{virtual_network_id}
APIs.io Engineering Platform Delete a virtual network
tunnel-virtual-network-delete 2 params body → 4XX200
GET
/accounts/{account_id}/teamnet/virtual_networks/{virtual_network_id}
APIs.io Engineering Platform Get a virtual network
tunnel-virtual-network-get 2 params body → 4XX200
PATCH
/accounts/{account_id}/teamnet/virtual_networks/{virtual_network_id}
APIs.io Engineering Platform Update a virtual network
tunnel-virtual-network-update 2 params body → 4XX200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are tunnel_virtual-network (6 properties), tunnel_result_info (4 properties), tunnel_api-response-common (4 properties), tunnel_api-response-common-failure (4 properties). Each schema is shown below with its type and property counts.

tunnel_virtual_network_name
string
A user-friendly name for the virtual network.
tunnel_virtual_network_comment
string
Optional remark describing the virtual network.
tunnel_api-response-common-failure
object
4 properties 4 required
tunnel_is_default_network
boolean
If true, this virtual network is the default for the account.
tunnel_account_id
string
Cloudflare account ID
tunnel_virtual-network
object
6 properties 5 required
tunnel_vnet_response_collection
tunnel_vnet_response_single
tunnel_virtual_network_id
string
UUID of the virtual network.
tunnel_api-response-collection
object
tunnel_deleted_at
string
Timestamp of when the resource was deleted. If null, the resource has not been deleted.
tunnel_messages
array
tunnel_api-response-single
tunnel_result_info
object
4 properties
tunnel_created_at
string
Timestamp of when the resource was created.
tunnel_api-response-common
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-tunnel-virtual-network-api-openapi.yml Raw ↑