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 IPsec Tunnels API

The Magic IPsec Tunnels API from APIs.io Engineering Platform — 3 operation(s) for magic ipsec tunnels.

This API exposes 7 operations across 3 paths, and defines 29 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.

7 operations 3 paths 29 schemas 1 DELETE2 GET2 POST2 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 IPsec Tunnels 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 7

Across 3 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Magic IPsec Tunnels 7
GET
/accounts/{account_id}/magic/ipsec_tunnels
APIs.io Engineering Platform List IPsec tunnels
magic-ipsec-tunnels-list-ipsec-tunnels 1 param → 4XX200
POST
/accounts/{account_id}/magic/ipsec_tunnels
APIs.io Engineering Platform Create IPsec tunnels
magic-ipsec-tunnels-create-ipsec-tunnels 1 param body → 4XX200
PUT
/accounts/{account_id}/magic/ipsec_tunnels
APIs.io Engineering Platform Update multiple IPsec tunnels
magic-ipsec-tunnels-update-multiple-ipsec-tunnels 1 param body → 4XX200
DELETE
/accounts/{account_id}/magic/ipsec_tunnels/{ipsec_tunnel_id}
APIs.io Engineering Platform Delete IPsec Tunnel
magic-ipsec-tunnels-delete-ipsec-tunnel 2 params body → 4XX200
GET
/accounts/{account_id}/magic/ipsec_tunnels/{ipsec_tunnel_id}
APIs.io Engineering Platform List IPsec tunnel details
magic-ipsec-tunnels-list-ipsec-tunnel-details 2 params → 4XX200
PUT
/accounts/{account_id}/magic/ipsec_tunnels/{ipsec_tunnel_id}
APIs.io Engineering Platform Update IPsec Tunnel
magic-ipsec-tunnels-update-ipsec-tunnel 2 params body → 4XX200
POST
/accounts/{account_id}/magic/ipsec_tunnels/{ipsec_tunnel_id}/psk_generate
APIs.io Engineering Platform Generate Pre Shared Key (PSK) for IPsec tunnels
magic-ipsec-tunnels-generate-pre-shared-key-(-psk)-for-ipsec-tunnels 2 params body → 4XX200

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are magic_ipsec-tunnel (12 properties), magic_schemas-tunnel_add_single_request (8 properties), magic_health_check (5 properties), magic_api-response-common-failure (4 properties). Each schema is shown below with its type and property counts.

magic_schemas-created_on
string
The date and time the tunnel was created.
magic_api-response-single
object
magic_psk
string
A randomly generated or provided string for use in the IPsec tunnel.
magic_replay_protection
boolean
If true, then IPsec replay protection will be supported in the Cloudflare-to-customer direction.
magic_schemas-tunnels_collection_response
magic_psk_generation_response
magic_schemas-modified_tunnels_collection_response
magic_health_check
object
5 properties
magic_schemas-identifier
string
Tunnel identifier tag.
magic_cloudflare_ipsec_endpoint
string
The IP address assigned to the Cloudflare side of the IPsec tunnel.
magic_psk_metadata
object
The PSK metadata that includes when the PSK was generated.
1 property
magic_schemas-tunnel_add_request
magic_schemas-tunnel_single_response
magic_identifier
string
Identifier
magic_api-response-common
object
4 properties 4 required
magic_allow_null_cipher
boolean
When true, the tunnel can use a null-cipher (ENCRNULL) in the ESP tunnel (Phase 2).
magic_schemas-name
string
The name of the IPsec tunnel. The name cannot share a name with other tunnels.
magic_schemas-tunnel_deleted_response
magic_schemas-tunnel_modified_response
magic_schemas-tunnel_add_single_request
object
8 properties 3 required
magic_messages
array
magic_interface_address
string
A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side of the tunnel. Select the subnet from the following private IP space: 10.0.0.0–1…
magic_components-schemas-description
string
An optional description forthe IPsec tunnel.
magic_schemas-modified_on
string
The date and time the tunnel was last modified.
magic_ipsec-tunnel
object
12 properties 3 required
magic_schemas-tunnel_update_request
magic_api-response-common-failure
object
4 properties 4 required
magic_customer_ipsec_endpoint
string
The IP address assigned to the customer side of the IPsec tunnel. Not required, but must be set for proactive traceroutes to work.
magic_tunnel_health_check
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-magic-ipsec-tunnels-api-openapi.yml Raw ↑