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

The IP Address Management Prefixes API from APIs.io Engineering Platform — 4 operation(s) for ip address management prefixes.

This API exposes 7 operations across 4 paths, and defines 21 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 4 paths 21 schemas 1 DELETE3 GET1 PATCH2 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 Prefixes 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 4 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

IP Address Management Prefixes 7
POST
/accounts/{account_id}/addressing/loa_documents
APIs.io Engineering Platform Upload LOA Document
ip-address-management-prefixes-upload-loa-document 1 param body → 4XX201
GET
/accounts/{account_id}/addressing/loa_documents/{loa_document_id}/download
APIs.io Engineering Platform Download LOA Document
ip-address-management-prefixes-download-loa-document 2 params → 4XX200
GET
/accounts/{account_id}/addressing/prefixes
APIs.io Engineering Platform List Prefixes
ip-address-management-prefixes-list-prefixes 1 param → 4XX200
POST
/accounts/{account_id}/addressing/prefixes
APIs.io Engineering Platform Add Prefix
ip-address-management-prefixes-add-prefix 1 param body → 4XX201
DELETE
/accounts/{account_id}/addressing/prefixes/{prefix_id}
APIs.io Engineering Platform Delete Prefix
ip-address-management-prefixes-delete-prefix 2 params body → 4XX200
GET
/accounts/{account_id}/addressing/prefixes/{prefix_id}
APIs.io Engineering Platform Prefix Details
ip-address-management-prefixes-prefix-details 2 params → 4XX200
PATCH
/accounts/{account_id}/addressing/prefixes/{prefix_id}
APIs.io Engineering Platform Update Prefix Description
ip-address-management-prefixes-update-prefix-description 2 params body → 4XX200

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are addressing_ipam-prefixes (13 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_loa_upload_response
addressing_api-response-collection
object
addressing_messages
array
addressing_advertised
boolean
Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.
addressing_approved
string
Approval state of the prefix (P = pending, V = active).
addressing_loa_document_identifier
string
Identifier for the uploaded LOA document.
addressing_asn
integer
Autonomous System Number (ASN) the prefix will be advertised under.
addressing_on_demand_enabled
boolean
Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.
addressing_result_info
object
4 properties
addressing_description
string
Description of the prefix.
addressing_cidr
string
IP Prefix in Classless Inter-Domain Routing format.
addressing_api-response-common-failure
object
4 properties 4 required
addressing_single_response
addressing_timestamp
string
addressing_identifier
string
Identifier
addressing_ipam-prefixes
object
13 properties
addressing_response_collection
addressing_api-response-common
object
3 properties 3 required
addressing_modified_at_nullable
string
Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.
addressing_on_demand_locked
boolean
Whether advertisement status of the prefix is locked, meaning it cannot be changed.
addressing_api-response-single
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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