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 Magic GRE Tunnels API

The Magic GRE Tunnels API from APIs.io Engineering Platform — 2 operation(s) for magic gre tunnels.

This API exposes 6 operations across 2 paths, and defines 24 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.

6 operations 2 paths 24 schemas 1 DELETE2 GET1 POST2 PUT

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 Magic GRE Tunnels 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 6

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

Magic GRE Tunnels 6
GET
/accounts/{account_id}/magic/gre_tunnels
APIs.io Engineering Platform List GRE tunnels
magic-gre-tunnels-list-gre-tunnels 1 param → 4XX200
POST
/accounts/{account_id}/magic/gre_tunnels
APIs.io Engineering Platform Create GRE tunnels
magic-gre-tunnels-create-gre-tunnels 1 param body → 4XX200
PUT
/accounts/{account_id}/magic/gre_tunnels
APIs.io Engineering Platform Update multiple GRE tunnels
magic-gre-tunnels-update-multiple-gre-tunnels 1 param body → 4XX200
DELETE
/accounts/{account_id}/magic/gre_tunnels/{gre_tunnel_id}
APIs.io Engineering Platform Delete GRE Tunnel
magic-gre-tunnels-delete-gre-tunnel 2 params body → 4XX200
GET
/accounts/{account_id}/magic/gre_tunnels/{gre_tunnel_id}
APIs.io Engineering Platform List GRE Tunnel Details
magic-gre-tunnels-list-gre-tunnel-details 2 params → 4XX200
PUT
/accounts/{account_id}/magic/gre_tunnels/{gre_tunnel_id}
APIs.io Engineering Platform Update GRE Tunnel
magic-gre-tunnels-update-gre-tunnel 2 params body → 4XX200

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are magic_gre-tunnel (11 properties), magic_tunnel_add_single_request (8 properties), magic_health_check (5 properties), magic_api-response-common (4 properties). Each schema is shown below with its type and property counts.

magic_schemas-created_on
string
The date and time the tunnel was created.
magic_tunnel_single_response
magic_api-response-single
object
magic_tunnel_add_single_request
object
8 properties 4 required
magic_health_check
object
5 properties
magic_schemas-identifier
string
Tunnel identifier tag.
magic_tunnel_modified_response
magic_identifier
string
Identifier
magic_ttl
integer
Time To Live (TTL) in number of hops of the GRE tunnel.
magic_customer_gre_endpoint
string
The IP address assigned to the customer side of the GRE tunnel.
magic_api-response-common
object
4 properties 4 required
magic_tunnels_collection_response
magic_messages
array
magic_schemas-description
string
An optional description of the GRE tunnel.
magic_tunnel_deleted_response
magic_interface_address
string
A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side of the tunnel. Select the subnet from the following private IP space: 10.0.0.0–1…
magic_modified_tunnels_collection_response
magic_tunnel_update_request
magic_schemas-modified_on
string
The date and time the tunnel was last modified.
magic_name
string
The name of the tunnel. The name cannot contain spaces or special characters, must be 15 characters or less, and cannot share a name with another GRE tunnel.
magic_mtu
integer
Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value is 576.
magic_api-response-common-failure
object
4 properties 4 required
magic_gre-tunnel
object
11 properties 4 required
magic_cloudflare_gre_endpoint
string
The IP address assigned to the Cloudflare side of the GRE tunnel.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-magic-gre-tunnels-api-openapi.yml Raw ↑