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

The Zero Trust Lists API from APIs.io Engineering Platform — 3 operation(s) for zero trust lists.

This API exposes 7 operations across 3 paths, and defines 22 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 22 schemas 1 DELETE3 GET1 PATCH1 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 Lists 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, 3 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Zero Trust Lists 7
GET
/accounts/{account_id}/gateway/lists
APIs.io Engineering Platform List Zero Trust lists
zero-trust-lists-list-zero-trust-lists 2 params → 4XX200
POST
/accounts/{account_id}/gateway/lists
APIs.io Engineering Platform Create Zero Trust list
zero-trust-lists-create-zero-trust-list 1 param body → 4XX200
DELETE
/accounts/{account_id}/gateway/lists/{list_id}
APIs.io Engineering Platform Delete Zero Trust list
zero-trust-lists-delete-zero-trust-list 2 params body → 4XX200
GET
/accounts/{account_id}/gateway/lists/{list_id}
APIs.io Engineering Platform Get Zero Trust list details
zero-trust-lists-zero-trust-list-details 2 params → 4XX200
PATCH
/accounts/{account_id}/gateway/lists/{list_id}
APIs.io Engineering Platform Patch Zero Trust list
zero-trust-lists-patch-zero-trust-list 2 params body → 4XX200
PUT
/accounts/{account_id}/gateway/lists/{list_id}
APIs.io Engineering Platform Update Zero Trust list
zero-trust-lists-update-zero-trust-list 2 params body → 4XX200
GET
/accounts/{account_id}/gateway/lists/{list_id}/items
APIs.io Engineering Platform Get Zero Trust list items
zero-trust-lists-zero-trust-list-items 2 params → 4XX200

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are zero-trust-gateway_lists (7 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_empty_response
zero-trust-gateway_name
string
The name of the list.
zero-trust-gateway_timestamp
string
zero-trust-gateway_schemas-single_response
zero-trust-gateway_api-response-single
object
zero-trust-gateway_schemas-uuid
string
API Resource UUID tag.
zero-trust-gateway_description_item
string
The description of the list item, if present
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_schemas-type
string
The type of list.
zero-trust-gateway_value
string
The value of the item in a list.
zero-trust-gateway_lists
object
7 properties
zero-trust-gateway_description
string
The description of the list.
zero-trust-gateway_identifier
string
zero-trust-gateway_items
array
The items in the list.
zero-trust-gateway_result_info
object
4 properties
zero-trust-gateway_schemas-response_collection
zero-trust-gateway_count
number
The number of items in the list.
zero-trust-gateway_api-response-collection
object
zero-trust-gateway_list_item_response_collection
zero-trust-gateway_messages
array
zero-trust-gateway_single_response_with_list_items

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-zero-trust-lists-api-openapi.yml Raw ↑