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

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

This API exposes 6 operations across 2 paths, and defines 16 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 16 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 Sites 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 Sites 6
GET
/accounts/{account_id}/magic/sites
APIs.io Engineering Platform List Sites
magic-sites-list-sites 2 params → 4XX200
POST
/accounts/{account_id}/magic/sites
APIs.io Engineering Platform Create a new Site
magic-sites-create-site 1 param body → 4XX200
DELETE
/accounts/{account_id}/magic/sites/{site_id}
APIs.io Engineering Platform Delete Site
magic-sites-delete-site 2 params body → 4XX200
GET
/accounts/{account_id}/magic/sites/{site_id}
APIs.io Engineering Platform Site Details
magic-sites-site-details 2 params → 4XX200
PATCH
/accounts/{account_id}/magic/sites/{site_id}
APIs.io Engineering Platform Patch Site
magic-sites-patch-site 2 params body → 4XX200
PUT
/accounts/{account_id}/magic/sites/{site_id}
APIs.io Engineering Platform Update Site
magic-sites-update-site 2 params body → 4XX200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are magic_site (7 properties), magic_sites_add_single_request (6 properties), magic_site_update_request (5 properties), magic_api-response-common (4 properties). Each schema is shown below with its type and property counts.

magic_api-response-common
object
4 properties 4 required
magic_sites_add_single_request
object
6 properties 1 required
magic_api-response-single
object
magic_site_update_request
object
5 properties
magic_site
object
7 properties
magic_site-location
object
Location of site in latitude and longitude.
2 properties
magic_site_modified_response
magic_site-name
string
The name of the site.
magic_messages
array
magic_site_deleted_response
magic_identifier
string
Identifier
magic_api-response-common-failure
object
4 properties 4 required
magic_sites_collection_response
magic_site_single_response
magic_connector-id
string
Magic Connector identifier tag.
magic_secondary-connector-id
string
Magic Connector identifier tag. Used when high availability mode is on.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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