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 Static Routes API

The Magic Static Routes API from APIs.io Engineering Platform — 2 operation(s) for magic static routes.

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

7 operations 2 paths 30 schemas 2 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 Static Routes 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 7

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

Magic Static Routes 7
DELETE
/accounts/{account_id}/magic/routes
APIs.io Engineering Platform Delete Many Routes
magic-static-routes-delete-many-routes 1 param body → 4XX200
GET
/accounts/{account_id}/magic/routes
APIs.io Engineering Platform List Routes
magic-static-routes-list-routes 1 param → 4XX200
POST
/accounts/{account_id}/magic/routes
APIs.io Engineering Platform Create Routes
magic-static-routes-create-routes 1 param body → 4XX200
PUT
/accounts/{account_id}/magic/routes
APIs.io Engineering Platform Update Many Routes
magic-static-routes-update-many-routes 1 param body → 4XX200
DELETE
/accounts/{account_id}/magic/routes/{route_id}
APIs.io Engineering Platform Delete Route
magic-static-routes-delete-route 2 params body → 4XX200
GET
/accounts/{account_id}/magic/routes/{route_id}
APIs.io Engineering Platform Route Details
magic-static-routes-route-details 2 params → 4XX200
PUT
/accounts/{account_id}/magic/routes/{route_id}
APIs.io Engineering Platform Update Route
magic-static-routes-update-route 2 params body → 4XX200

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are magic_route (9 properties), magic_route_add_single_request (6 properties), magic_api-response-common-failure (4 properties), magic_api-response-common (4 properties). Each schema is shown below with its type and property counts.

magic_api-response-single
object
magic_scope
object
Used only for ECMP routes.
2 properties
magic_colo_regions
array
List of colo regions for the ECMP scope.
magic_prefix
string
IP Prefix in Classless Inter-Domain Routing format.
magic_route_deleted_response
magic_colo_name
string
Scope colo name.
magic_created_on
string
When the route was created.
magic_identifier
string
Identifier
magic_multiple_route_modified_response
magic_api-response-common
object
4 properties 4 required
magic_route_update_single_request
magic_colo_names
array
List of colo names for the ECMP scope.
magic_route_delete_id
magic_multiple_route_delete_response
magic_route
object
9 properties 3 required
magic_colo_region
string
Scope colo region.
magic_description
string
An optional human provided description of the static route.
magic_messages
array
magic_route_modified_response
magic_nexthop
string
The next-hop IP Address for the static route.
magic_routes_collection_response
magic_priority
integer
Priority of the static route.
magic_route_update_request
magic_modified_on
string
When the route was last modified.
magic_route_single_response
magic_route_update_many_request
object
1 property 1 required
magic_route_add_single_request
object
6 properties 3 required
magic_api-response-common-failure
object
4 properties 4 required
magic_weight
integer
Optional weight of the ECMP scope - if provided.
magic_route_delete_many_request
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-magic-static-routes-api-openapi.yml Raw ↑