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

The Magic Interconnects API from APIs.io Engineering Platform — 2 operation(s) for magic interconnects.

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

4 operations 2 paths 20 schemas 2 GET2 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 Interconnects 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 4

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

Magic Interconnects 4
GET
/accounts/{account_id}/magic/cf_interconnects
APIs.io Engineering Platform List interconnects
magic-interconnects-list-interconnects 1 param → 4XX200
PUT
/accounts/{account_id}/magic/cf_interconnects
APIs.io Engineering Platform Update multiple interconnects
magic-interconnects-update-multiple-interconnects 1 param body → 4XX200
GET
/accounts/{account_id}/magic/cf_interconnects/{cf_interconnect_id}
APIs.io Engineering Platform List interconnect Details
magic-interconnects-list-interconnect-details 2 params → 4XX200
PUT
/accounts/{account_id}/magic/cf_interconnects/{cf_interconnect_id}
APIs.io Engineering Platform Update interconnect
magic-interconnects-update-interconnect 2 params body → 4XX200

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are magic_interconnect (10 properties), magic_components-schemas-tunnel_update_request (5 properties), magic_api-response-common (4 properties), magic_api-response-common-failure (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_api-response-single
object
magic_schemas-identifier
string
Tunnel identifier tag.
magic_identifier
string
Identifier
magic_schemas-health_check
object
4 properties
magic_interconnect_components-schemas-description
string
An optional description of the interconnect.
magic_components-schemas-modified_tunnels_collection_response
magic_api-response-common
object
4 properties 4 required
magic_components-schemas-tunnel_update_request
object
5 properties
magic_messages
array
magic_components-schemas-tunnel_single_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_gre
object
The configuration specific to GRE interconnects.
1 property
magic_schemas-modified_on
string
The date and time the tunnel was last modified.
magic_components-schemas-tunnels_collection_response
magic_interconnect
object
10 properties
magic_components-schemas-tunnel_modified_response
magic_api-response-common-failure
object
4 properties 4 required
magic_schemas-mtu
integer
The Maximum Transmission Unit (MTU) in bytes for the interconnect. The minimum value is 576.
magic_components-schemas-name
string
The name of the interconnect. The name cannot share a name with other tunnels.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-magic-interconnects-api-openapi.yml Raw ↑