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 Zero Trust Connectivity Settings API

The Zero Trust Connectivity Settings API from APIs.io Engineering Platform — 1 operation(s) for zero trust connectivity settings.

This API exposes 2 operations across 1 path, and defines 8 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.

2 operations 1 paths 8 schemas 1 GET1 PATCH

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 Zero Trust Connectivity Settings 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 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

Zero Trust Connectivity Settings 2
GET
/accounts/{account_id}/zerotrust/connectivity_settings
APIs.io Engineering Platform Get Zero Trust Connectivity Settings
zero-trust-accounts-get-connectivity-settings 1 param → 4XX200
PATCH
/accounts/{account_id}/zerotrust/connectivity_settings
APIs.io Engineering Platform Updates the Zero Trust Connectivity Settings
zero-trust-accounts-patch-connectivity-settings 1 param body → 4XX200

Schemas 8

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

tunnel_api-response-common-failure
object
4 properties 4 required
tunnel_account_id
string
Cloudflare account ID
tunnel_offramp_warp_enabled
boolean
A flag to enable WARP to WARP traffic.
tunnel_api-response-single
tunnel_messages
array
tunnel_icmp_proxy_enabled
boolean
A flag to enable the ICMP proxy for the account network.
tunnel_zero_trust_connectivity_settings_response
tunnel_api-response-common
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-zero-trust-connectivity-settings-api-openapi.yml Raw ↑