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 IP Address Management Prefix Delegation API

The IP Address Management Prefix Delegation API from APIs.io Engineering Platform — 2 operation(s) for ip address management prefix delegation.

This API exposes 3 operations across 2 paths, and defines 15 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.

3 operations 2 paths 15 schemas 1 DELETE1 GET1 POST

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 IP Address Management Prefix Delegation 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 3

Across 2 paths, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

IP Address Management Prefix Delegation 3
GET
/accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations
APIs.io Engineering Platform List Prefix Delegations
ip-address-management-prefix-delegation-list-prefix-delegations 2 params → 4XX200
POST
/accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations
APIs.io Engineering Platform Create Prefix Delegation
ip-address-management-prefix-delegation-create-prefix-delegation 2 params body → 4XX200
DELETE
/accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations/{delegation_id}
APIs.io Engineering Platform Delete Prefix Delegation
ip-address-management-prefix-delegation-delete-prefix-delegation 3 params body → 4XX200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are addressing_ipam-delegations (6 properties), addressing_api-response-common-failure (4 properties), addressing_result_info (4 properties), addressing_api-response-common (3 properties). Each schema is shown below with its type and property counts.

addressing_result_info
object
4 properties
addressing_cidr
string
IP Prefix in Classless Inter-Domain Routing format.
addressing_messages
array
addressing_api-response-single
object
addressing_api-response-collection
object
addressing_schemas-single_response
addressing_api-response-common-failure
object
4 properties 4 required
addressing_delegated_account_identifier
string
Account identifier for the account to which prefix is being delegated.
addressing_api-response-common
object
3 properties 3 required
addressing_timestamp
string
addressing_identifier
string
Identifier
addressing_schemas-response_collection
addressing_delegation_identifier
string
Delegation identifier tag.
addressing_id_response
addressing_ipam-delegations
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-ip-address-management-prefix-delegation-api-openapi.yml Raw ↑