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

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

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

Schemas 18

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

magic_acl_single_response
magic_ip-address
string
A valid IPv4 address.
magic_api-response-single
object
magic_forward_locally
boolean
The desired forwarding action for this ACL policy. If set to "false", the policy will forward traffic to Cloudflare. If set to "true", the policy will forward…
magic_acls_add_single_request
object
Bidirectional ACL policy for local network traffic within a site.
6 properties 3 required
magic_acl_modified_response
magic_acl-subnet
magic_api-response-common-failure
object
4 properties 4 required
magic_cidr
string
A valid CIDR notation representing an IP range.
magic_port
integer
magic_messages
array
magic_lan-acl-configuration
object
4 properties 1 required
magic_acl_update_request
object
6 properties
magic_identifier
string
Identifier
magic_acl
object
Bidirectional ACL policy for network traffic within a site.
7 properties
magic_acls_collection_response
magic_acl_deleted_response
magic_api-response-common
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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