This API exposes
11 operations
across 5 paths,
and defines 26 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 paths26 schemas4 DELETE2 GET1 PATCH1 POST3 PUT
Metadata
The identity and technical contract details declared by the specification.
APIs.io Engineering Platform IP Address Management Address Maps 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 — 4 DELETE, 2 GET, 1 PATCH, 1 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are addressing_address-maps (8 properties), addressing_api-response-common-failure (4 properties), addressing_result_info (4 properties), addressing_address-maps-membership (4 properties). Each schema is shown below with its type and property counts.
addressing_memberships
array
Zones and Accounts which will be assigned IPs on this Address Map. A zone membership will take priority over an account membership.
addressing_messages
array
addressing_api-response-collection
object
addressing_kind
string
The type of the membership.
addressing_address-maps
object
8 properties
addressing_default_sni
string
If you have legacy TLS clients which do not send the TLS server name indicator, then you can specify one default SNI on the map. If Cloudflare receives a TLS h…
addressing_enabled
boolean
Whether the Address Map is enabled or not. Cloudflare's DNS will not respond with IP addresses on an Address Map until the map is enabled.
addressing_result_info
object
4 properties
addressing_address-maps-ip
object
2 properties
addressing_api-response-common-failure
object
4 properties4 required
addressing_address-maps-membership
object
4 properties
addressing_timestamp
string
addressing_identifier
string
Identifier
addressing_schemas-description
string
An optional description field which may be used to describe the types of IPs or zones on the map.
addressing_schemas-can_delete
boolean
Controls whether the membership can be deleted via the API or not.
addressing_components-schemas-response_collection
addressing_can_delete
boolean
If set to false, then the Address Map cannot be deleted via API. This is true for Cloudflare-managed maps.
addressing_ip_address
string
An IPv4 or IPv6 address.
addressing_api-response-common
object
3 properties3 required
addressing_components-schemas-single_response
addressing_schemas-ips
array
The set of IPs on the Address Map.
addressing_api-response-single
object
addressing_full_response
addressing_schemas-identifier
string
The identifier for the membership (eg. a zone or account tag).
addressing_can_modify_ips
boolean
If set to false, then the IPs on the Address Map cannot be modified via the API. This is true for Cloudflare-managed maps.
addressing_ip
string
An IPv4 or IPv6 address.
Specification
The full machine-readable OpenAPI contract behind this narrative.
