This API exposes
11 operations
across 5 paths,
and defines 32 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.
11 operations5 paths32 schemas2 DELETE5 GET2 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
APIs.io Engineering Platform 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 11
Across 5 paths, the API surfaces 11 operations — 2 DELETE, 5 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
APIs.io Engineering Platform Get bulk operation status
lists-get-bulk-operation-status2 params→ 4XX200
Schemas 32
The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are lists_item (8 properties), lists_list (8 properties), lists_item_redirect (7 properties), lists_api-response-common (4 properties). Each schema is shown below with its type and property counts.
lists_item
object
8 properties
lists_bulk-operation-response-collection
lists_item_comment
string
An informative summary of the list item.
lists_item_hostname
object
Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (), and the hyphen (-).
1 property1 required
lists_item_id
string
The unique ID of the item in the List.
lists_operation
object
4 properties2 required
lists_lists-async-response
lists_modified_on
string
The RFC 3339 timestamp of when the list was last modified.
lists_messages
array
lists_num_items
number
The number of items in the list.
lists_list
object
8 properties
lists_api-response-common
object
4 properties4 required
lists_api-response-collection
object
lists_identifier
string
Identifier
lists_lists-response-collection
object
lists_item-response-collection
lists_item_asn
integer
A non-negative 32 bit integer
lists_created_on
string
The RFC 3339 timestamp of when the list was created.
lists_num_referencing_filters
number
The number of [filters](/operations/filters-list-filters) referencing the list.
lists_description
string
An informative summary of the list.
lists_name
string
An informative name for the list. Use this name in filter and rule expressions.
lists_kind
The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects).
lists_item_ip
string
An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /64.
lists_list-delete-response-collection
object
lists_items
array
lists_items-update-request-collection
array
lists_list_id
string
The unique ID of the list.
lists_item_redirect
object
The definition of the redirect.
7 properties2 required
lists_operation_id
string
The unique operation ID of the asynchronous action.
lists_items-list-response-collection
lists_list-response-collection
object
lists_api-response-common-failure
object
4 properties4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
