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 App Configs API

The Magic Site App Configs API from APIs.io Engineering Platform — 2 operation(s) for magic site app configs.

This API exposes 4 operations across 2 paths, and defines 13 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 13 schemas 1 DELETE1 GET1 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 App Configs 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 — 1 DELETE, 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Magic Site App Configs 4
GET
/accounts/{account_id}/magic/sites/{site_id}/app_configs
APIs.io Engineering Platform List App Configs
magic-site-app-configs-list-app-configs 2 params → 4XX200
POST
/accounts/{account_id}/magic/sites/{site_id}/app_configs
APIs.io Engineering Platform Create a new App Config
magic-site-app-configs-add-app-config 2 params body → 4XX201
DELETE
/accounts/{account_id}/magic/sites/{site_id}/app_configs/{app_config_id}
APIs.io Engineering Platform Delete App Config
magic-site-app-configs-delete-app-config 3 params → 4XX200
PUT
/accounts/{account_id}/magic/sites/{site_id}/app_configs/{app_config_id}
APIs.io Engineering Platform Update an App Config
magic-site-app-configs-update-app-config 3 params body → 4XX200

Schemas 13

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

magic_account_app_id
string
Magic account app ID.
magic_app_configs_collection_response
magic_app_config_add_single_request
object
magic_apps-response-object
object
4 properties 4 required
magic_app_config
object
Traffic decision configuration for an app.
magic_app_breakout
boolean
Whether to breakout traffic to the app's endpoints directly. Null preserves default behavior.
magic_managed_app_id
string
Managed app ID.
magic_messages
array
magic_identifier
string
Identifier
magic_api-response-common-failure
object
4 properties 4 required
magic_app_priority
integer
Priority of traffic. 0 is default, anything greater is prioritized. (Currently only 0 and 1 are supported)
magic_app_config_update_request
object
4 properties
magic_app_config_single_response

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-magic-site-app-configs-api-openapi.yml Raw ↑