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 Routing API

The Tunnel Routing API from APIs.io Engineering Platform — 4 operation(s) for tunnel routing.

This API exposes 9 operations across 4 paths, and defines 27 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.

9 operations 4 paths 27 schemas 2 DELETE3 GET2 PATCH2 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 Routing 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 9

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

Tunnel Routing 9
GET
/accounts/{account_id}/teamnet/routes
APIs.io Engineering Platform List tunnel routes
tunnel-route-list-tunnel-routes 12 params → 4XX200
POST
/accounts/{account_id}/teamnet/routes
APIs.io Engineering Platform Create a tunnel route
tunnel-route-create-a-tunnel-route 1 param body → 4XX200
DELETE
/accounts/{account_id}/teamnet/routes/{route_id}
APIs.io Engineering Platform Delete a tunnel route
tunnel-route-delete-a-tunnel-route 2 params → 4XX200
GET
/accounts/{account_id}/teamnet/routes/{route_id}
APIs.io Engineering Platform Get tunnel route
tunnel-route-get-tunnel-route 2 params → 4XX200
PATCH
/accounts/{account_id}/teamnet/routes/{route_id}
APIs.io Engineering Platform Update a tunnel route
tunnel-route-update-a-tunnel-route 2 params body → 4XX200
GET
/accounts/{account_id}/teamnet/routes/ip/{ip}
APIs.io Engineering Platform Get tunnel route by IP
tunnel-route-get-tunnel-route-by-ip 3 params → 4XX200
DELETE
/accounts/{account_id}/teamnet/routes/network/{ip_network_encoded}deprecated
APIs.io Engineering Platform Delete a tunnel route (CIDR Endpoint)
tunnel-route-delete-a-tunnel-route-with-cidr 5 params → 4XX200
PATCH
/accounts/{account_id}/teamnet/routes/network/{ip_network_encoded}deprecated
APIs.io Engineering Platform Update a tunnel route (CIDR Endpoint)
tunnel-route-update-a-tunnel-route-with-cidr 2 params → 4XX200
POST
/accounts/{account_id}/teamnet/routes/network/{ip_network_encoded}deprecated
APIs.io Engineering Platform Create a tunnel route (CIDR Endpoint)
tunnel-route-create-a-tunnel-route-with-cidr 2 params body → 4XX200

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are tunnel_teamnet (10 properties), tunnel_route (7 properties), tunnel_api-response-common (4 properties), tunnel_result_info (4 properties). Each schema is shown below with its type and property counts.

tunnel_account_id
string
Cloudflare account ID
tunnel_ip_network
string
The private IPv4 or IPv6 range connected by the route, in CIDR notation.
tunnel_route_response_single
tunnel_tunnel_types
string
The types of tunnels to filter separated by a comma.
tunnel_existed_at
string
If provided, include only tunnels that were created (and not deleted) before this time.
tunnel_api-response-single
tunnel_teamnet_response_single
tunnel_per_page
number
Number of results to display.
tunnel_route_id
string
UUID of the route.
tunnel_ip
string
tunnel_api-response-common-failure
object
4 properties 4 required
tunnel_route
object
7 properties
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-common
object
4 properties 4 required
tunnel_virtual_network_name
string
A user-friendly name for the virtual network.
tunnel_tunnel_id
string
UUID of the tunnel.
tunnel_tunnel_name
string
A user-friendly name for a tunnel.
tunnel_teamnet
object
10 properties
tunnel_virtual_network_id
string
UUID of the virtual network.
tunnel_tunnel_type
string
The type of tunnel.
tunnel_teamnet_response_collection
tunnel_ip_network_encoded
string
IP/CIDR range in URL-encoded format
tunnel_api-response-collection
object
tunnel_comment
string
Optional remark describing the route.
tunnel_result_info
object
4 properties
tunnel_created_at
string
Timestamp of when the resource was created.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-tunnel-routing-api-openapi.yml Raw ↑