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 Site LANs API

The Magic Site LANs API from APIs.io Engineering Platform — 2 operation(s) for magic site lans.

This API exposes 6 operations across 2 paths, and defines 21 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 21 schemas 1 DELETE2 GET1 PATCH1 POST1 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 Site LANs 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 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Magic Site LANs 6
GET
/accounts/{account_id}/magic/sites/{site_id}/lans
APIs.io Engineering Platform List Site LANs
magic-site-lans-list-lans 2 params → 4XX200
POST
/accounts/{account_id}/magic/sites/{site_id}/lans
APIs.io Engineering Platform Create a new Site LAN
magic-site-lans-create-lan 2 params body → 4XX200
DELETE
/accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id}
APIs.io Engineering Platform Delete Site LAN
magic-site-lans-delete-lan 3 params body → 4XX200
GET
/accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id}
APIs.io Engineering Platform Site LAN Details
magic-site-lans-lan-details 3 params → 4XX200
PATCH
/accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id}
APIs.io Engineering Platform Patch Site LAN
magic-site-lans-patch-lan 3 params body → 4XX200
PUT
/accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id}
APIs.io Engineering Platform Update Site LAN
magic-site-lans-update-lan 3 params body → 4XX200

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are magic_lan (9 properties), magic_lans_add_single_request (7 properties), magic_lan_update_request (6 properties), magic_lan_static_addressing (5 properties). Each schema is shown below with its type and property counts.

magic_lan_static_addressing
object
If the site is not configured in high availability mode, this configuration is optional (if omitted, use DHCP). However, if in high availability mode, staticad…
5 properties 1 required
magic_api-response-single
object
magic_nat
object
1 property
magic_identifier
string
Identifier
magic_port
integer
magic_api-response-common
object
4 properties 4 required
magic_ip-address
string
A valid IPv4 address.
magic_lans_add_single_request
object
7 properties 2 required
magic_messages
array
magic_lan_deleted_response
magic_cidr
string
A valid CIDR notation representing an IP range.
magic_lan_dhcp_relay
object
1 property
magic_vlan_tag
integer
VLAN port number.
magic_lans_collection_response
magic_lan_update_request
object
6 properties
magic_lan_single_response
magic_routed_subnet
object
3 properties 2 required
magic_lan_modified_response
magic_lan_dhcp_server
object
4 properties
magic_api-response-common-failure
object
4 properties 4 required
magic_lan
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-magic-site-lans-api-openapi.yml Raw ↑