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

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

This API exposes 5 operations across 2 paths, and defines 27 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 27 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 Rules 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 Rules 5
GET
/accounts/{account_id}/gateway/rules
APIs.io Engineering Platform List Zero Trust Gateway rules
zero-trust-gateway-rules-list-zero-trust-gateway-rules 1 param → 4XX200
POST
/accounts/{account_id}/gateway/rules
APIs.io Engineering Platform Create a Zero Trust Gateway rule
zero-trust-gateway-rules-create-zero-trust-gateway-rule 1 param body → 4XX200
DELETE
/accounts/{account_id}/gateway/rules/{rule_id}
APIs.io Engineering Platform Delete a Zero Trust Gateway rule
zero-trust-gateway-rules-delete-zero-trust-gateway-rule 2 params body → 4XX200
GET
/accounts/{account_id}/gateway/rules/{rule_id}
APIs.io Engineering Platform Get Zero Trust Gateway rule details
zero-trust-gateway-rules-zero-trust-gateway-rule-details 2 params → 4XX200
PUT
/accounts/{account_id}/gateway/rules/{rule_id}
APIs.io Engineering Platform Update a Zero Trust Gateway rule
zero-trust-gateway-rules-update-zero-trust-gateway-rule 2 params body → 4XX200

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are zero-trust-gateway_rule-settings (21 properties), zero-trust-gateway_rules (15 properties), zero-trust-gateway_schedule (8 properties), zero-trust-gateway_dns_resolver_settings_v6 (4 properties). Each schema is shown below with its type and property counts.

zero-trust-gateway_empty_response
zero-trust-gateway_rules_components-schemas-response_collection
zero-trust-gateway_schedule
object
The schedule for activating DNS policies. This does not apply to HTTP or network policies.
8 properties
zero-trust-gateway_rules
object
15 properties
zero-trust-gateway_timestamp
string
zero-trust-gateway_traffic
string
The wirefilter expression used for traffic matching.
zero-trust-gateway_api-response-single
object
zero-trust-gateway_identity
string
The wirefilter expression used for identity matching.
zero-trust-gateway_schemas-description
string
The description of the rule.
zero-trust-gateway_api-response-common-failure
object
4 properties 4 required
zero-trust-gateway_api-response-common
object
3 properties 3 required
zero-trust-gateway_device_posture
string
The wirefilter expression used for device posture check matching.
zero-trust-gateway_identifier
string
zero-trust-gateway_filters
array
The protocol or layer to evaluate the traffic, identity, and device posture expressions.
zero-trust-gateway_rules_components-schemas-single_response
zero-trust-gateway_result_info
object
4 properties
zero-trust-gateway_rule-settings
object
Additional settings that modify the rule's action.
21 properties
zero-trust-gateway_api-response-collection
object
zero-trust-gateway_precedence
integer
Precedence sets the order of your rules. Lower values indicate higher precedence. At each processing phase, applicable rules are evaluated in ascending order o…
zero-trust-gateway_messages
array
zero-trust-gateway_dns_resolver_settings_v6
object
4 properties 1 required
zero-trust-gateway_deleted_at
string
Date of deletion, if any.
zero-trust-gateway_rules_components-schemas-uuid
string
The API resource UUID.
zero-trust-gateway_dns_resolver_settings_v4
object
4 properties 1 required
zero-trust-gateway_enabled
boolean
True if the rule is enabled.
zero-trust-gateway_action
string
The action to preform when the associated traffic, identity, and device posture expressions are either absent or evaluate to true.
zero-trust-gateway_components-schemas-name
string
The name of the rule.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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