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 Account Apps API

The Magic Account Apps API from APIs.io Engineering Platform — 2 operation(s) for magic account apps.

This API exposes 4 operations across 2 paths, and defines 19 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 19 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 Account Apps 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 Account Apps 4
GET
/accounts/{account_id}/magic/apps
APIs.io Engineering Platform List Apps
magic-account-apps-list-apps 1 param → 4XX200
POST
/accounts/{account_id}/magic/apps
APIs.io Engineering Platform Create a new App
magic-account-apps-add-app 1 param body → 4XX201
DELETE
/accounts/{account_id}/magic/apps/{account_app_id}
APIs.io Engineering Platform Delete Account App
magic-account-apps-delete-app 2 params → 4XX200
PUT
/accounts/{account_id}/magic/apps/{account_app_id}
APIs.io Engineering Platform Update an App
magic-account-apps-update-app 2 params body → 4XX200

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are magic_managed_app (5 properties), magic_account_app (5 properties), magic_app_update_request (4 properties), magic_apps-response-array (4 properties). Each schema is shown below with its type and property counts.

magic_apps-response-array
object
4 properties 4 required
magic_managed_app_id
string
Managed app ID.
magic_identifier
string
Identifier
magic_managed_app
object
Managed app defined by Cloudflare.
5 properties 1 required
magic_app_single_response
magic_account_app
object
Custom app defined for an account.
5 properties 1 required
magic_messages
array
magic_app_type
string
Category of the app.
magic_app_hostnames
array
FQDNs to associate with traffic decisions.
magic_account_app_id
string
Magic account app ID.
magic_apps-response-object
object
4 properties 4 required
magic_cidr
string
A valid CIDR notation representing an IP range.
magic_app_subnets
array
CIDRs to associate with traffic decisions.
magic_app_name
string
Display name for the app.
magic_apps_collection_response
magic_app_update_request
object
4 properties
magic_app_add_single_request
object
4 properties 2 required
magic_app
object
Collection of Hostnames and/or IP Subnets to associate with traffic decisions.
magic_api-response-common-failure
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-magic-account-apps-api-openapi.yml Raw ↑