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

The Zero Trust Gateway Locations API from APIs.io Engineering Platform — 2 operation(s) for zero trust gateway locations.

This API exposes 5 operations across 2 paths, and defines 31 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 31 schemas 1 DELETE2 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 Zero Trust Gateway Locations 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 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Zero Trust Gateway Locations 5
GET
/accounts/{account_id}/gateway/locations
APIs.io Engineering Platform List Zero Trust Gateway locations
zero-trust-gateway-locations-list-zero-trust-gateway-locations 1 param → 4XX200
POST
/accounts/{account_id}/gateway/locations
APIs.io Engineering Platform Create a Zero Trust Gateway location
zero-trust-gateway-locations-create-zero-trust-gateway-location 1 param body → 4XX200
DELETE
/accounts/{account_id}/gateway/locations/{location_id}
APIs.io Engineering Platform Delete a Zero Trust Gateway location
zero-trust-gateway-locations-delete-zero-trust-gateway-location 2 params body → 4XX200
GET
/accounts/{account_id}/gateway/locations/{location_id}
APIs.io Engineering Platform Get Zero Trust Gateway location details
zero-trust-gateway-locations-zero-trust-gateway-location-details 2 params → 4XX200
PUT
/accounts/{account_id}/gateway/locations/{location_id}
APIs.io Engineering Platform Update a Zero Trust Gateway location
zero-trust-gateway-locations-update-zero-trust-gateway-location 2 params body → 4XX200

Schemas 31

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

zero-trust-gateway_ipv6_endpoint
object
2 properties
zero-trust-gateway_ip_networks
array
A list of allowed source IP network ranges for this endpoint. When empty, all source IPs are allowed. A non-empty list is only effective if the endpoint is ena…
zero-trust-gateway_ipv4_endpoint
object
1 property
zero-trust-gateway_ipv6_network
object
1 property 1 required
zero-trust-gateway_empty_response
zero-trust-gateway_dot_endpoint
object
2 properties
zero-trust-gateway_ip_network
object
1 property 1 required
zero-trust-gateway_timestamp
string
zero-trust-gateway_client-default
boolean
True if the location is the default location.
zero-trust-gateway_api-response-single
object
zero-trust-gateway_dns-destination-ips-id-write
string
The identifier of the pair of IPv4 addresses assigned to this location. When creating a location, if this field is absent or set with null, the pair of shared…
zero-trust-gateway_ipv6_networks
array
A list of allowed source IPv6 network ranges for this endpoint. When empty, all source IPs are allowed. A non-empty list is only effective if the endpoint is e…
zero-trust-gateway_ip
string
IPV6 destination ip assigned to this location. DNS requests sent to this IP will counted as the request under this location. This field is auto-generated by Ga…
zero-trust-gateway_api-response-common-failure
object
4 properties 4 required
zero-trust-gateway_schemas-name
string
The name of the location.
zero-trust-gateway_api-response-common
object
3 properties 3 required
zero-trust-gateway_components-schemas-response_collection
zero-trust-gateway_endpoints
object
The destination endpoints configured for this location. When updating a location, if this field is absent or set with null, the endpoints configuration remains…
4 properties
zero-trust-gateway_ipv4_networks
array
A list of network ranges that requests from this location would originate from. A non-empty list is only effective if the ipv4 endpoint is enabled for this loc…
zero-trust-gateway_doh_endpoint
object
3 properties
zero-trust-gateway_identifier
string
zero-trust-gateway_result_info
object
4 properties
zero-trust-gateway_locations
object
13 properties
zero-trust-gateway_ipv4_network
object
1 property 1 required
zero-trust-gateway_api-response-collection
object
zero-trust-gateway_messages
array
zero-trust-gateway_components-schemas-single_response
zero-trust-gateway_components-schemas-uuid
string
zero-trust-gateway_dns-destination-ips-id-read
string
The identifier of the pair of IPv4 addresses assigned to this location.
zero-trust-gateway_subdomain
string
The DNS over HTTPS domain to send DNS requests to. This field is auto-generated by Gateway.
zero-trust-gateway_ecs-support
boolean
True if the location needs to resolve EDNS queries.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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