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

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

This API exposes 3 operations across 2 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.

3 operations 2 paths 22 schemas 2 GET1 PATCH

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 BGP 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 3

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

IP Address Management BGP Prefixes 3
GET
/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes
APIs.io Engineering Platform List BGP Prefixes
ip-address-management-prefixes-list-bgp-prefixes 2 params → 4XX200
GET
/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes/{bgp_prefix_id}
APIs.io Engineering Platform Fetch BGP Prefix
ip-address-management-prefixes-fetch-bgp-prefix 3 params → 4XX200
PATCH
/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes/{bgp_prefix_id}
APIs.io Engineering Platform Update BGP Prefix
ip-address-management-prefixes-update-bgp-prefix 3 params body → 4XX200

Schemas 22

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

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_response_collection_bgp
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_cidr
string
IP Prefix in Classless Inter-Domain Routing format.
addressing_api-response-common-failure
object
4 properties 4 required
addressing_timestamp
string
addressing_identifier
string
Identifier
addressing_bgp_on_demand
object
4 properties
addressing_bgp_signal_opts
object
2 properties
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_bgp_signaling_modified_at
string
Last time BGP signaling control was toggled. This field is null if BGP signaling has never been enabled.
addressing_on_demand_locked
boolean
Whether advertisement status of the prefix is locked, meaning it cannot be changed.
addressing_bgp_prefix_update_advertisement
object
1 property
addressing_bgp_signaling_enabled
boolean
Whether control of advertisement of the prefix to the Internet is enabled to be performed via BGP signal
addressing_single_response_bgp
addressing_api-response-single
object
addressing_ipam-bgp-prefixes
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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