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 Dynamic Advertisement API

The IP Address Management Dynamic Advertisement API from APIs.io Engineering Platform — 1 operation(s) for ip address management dynamic advertisement.

This API exposes 2 operations across 1 path, and defines 8 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.

2 operations 1 paths 8 schemas 1 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 Dynamic Advertisement 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 2

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

IP Address Management Dynamic Advertisement 2
GET
/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/status
APIs.io Engineering Platform Get Advertisement Status
ip-address-management-dynamic-advertisement-get-advertisement-status 2 params → 4XX200
PATCH
/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/status
APIs.io Engineering Platform Update Prefix Dynamic Advertisement Status
ip-address-management-dynamic-advertisement-update-prefix-dynamic-advertisement-status 2 params body → 4XX200

Schemas 8

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

addressing_messages
array
addressing_api-response-single
object
addressing_api-response-common-failure
object
4 properties 4 required
addressing_advertised_response
addressing_schemas-advertised
boolean
Enablement of prefix advertisement to the Internet.
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_identifier
string
Identifier

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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