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 Gateway Proxy Endpoints API

The Zero Trust Gateway Proxy Endpoints API from APIs.io Engineering Platform — 2 operation(s) for zero trust gateway proxy endpoints.

This API exposes 5 operations across 2 paths, and defines 16 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.

5 operations 2 paths 16 schemas 1 DELETE2 GET1 PATCH1 POST

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 Gateway Proxy Endpoints 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 5

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

Zero Trust Gateway Proxy Endpoints 5
GET
/accounts/{account_id}/gateway/proxy_endpoints
APIs.io Engineering Platform List proxy endpoints
zero-trust-gateway-proxy-endpoints-list-proxy-endpoints 1 param → 4XX200
POST
/accounts/{account_id}/gateway/proxy_endpoints
APIs.io Engineering Platform Create a proxy endpoint
zero-trust-gateway-proxy-endpoints-create-proxy-endpoint 1 param body → 4XX200
DELETE
/accounts/{account_id}/gateway/proxy_endpoints/{proxy_endpoint_id}
APIs.io Engineering Platform Delete a proxy endpoint
zero-trust-gateway-proxy-endpoints-delete-proxy-endpoint 2 params body → 4XX200
GET
/accounts/{account_id}/gateway/proxy_endpoints/{proxy_endpoint_id}
APIs.io Engineering Platform Get a proxy endpoint
zero-trust-gateway-proxy-endpoints-proxy-endpoint-details 2 params → 4XX200
PATCH
/accounts/{account_id}/gateway/proxy_endpoints/{proxy_endpoint_id}
APIs.io Engineering Platform Update a proxy endpoint
zero-trust-gateway-proxy-endpoints-update-proxy-endpoint 2 params body → 4XX200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are zero-trust-gateway_proxy-endpoints (6 properties), zero-trust-gateway_result_info (4 properties), zero-trust-gateway_api-response-common-failure (4 properties), zero-trust-gateway_api-response-common (3 properties). Each schema is shown below with its type and property counts.

zero-trust-gateway_messages
array
zero-trust-gateway_proxy-endpoints_components-schemas-response_collection
zero-trust-gateway_schemas-subdomain
string
The subdomain to be used as the destination in the proxy client.
zero-trust-gateway_empty_response
zero-trust-gateway_components-schemas-uuid
string
zero-trust-gateway_api-response-common-failure
object
4 properties 4 required
zero-trust-gateway_proxy-endpoints
object
6 properties
zero-trust-gateway_proxy-endpoints_components-schemas-name
string
The name of the proxy endpoint.
zero-trust-gateway_timestamp
string
zero-trust-gateway_api-response-common
object
3 properties 3 required
zero-trust-gateway_proxy-endpoints_components-schemas-single_response
zero-trust-gateway_identifier
string
zero-trust-gateway_api-response-single
object
zero-trust-gateway_result_info
object
4 properties
zero-trust-gateway_ips
array
A list of CIDRs to restrict ingress connections.
zero-trust-gateway_api-response-collection
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-zero-trust-gateway-proxy-endpoints-api-openapi.yml Raw ↑