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 Secondary DNS (Peer) API

The Secondary DNS (Peer) API from APIs.io Engineering Platform — 2 operation(s) for secondary dns (peer).

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

5 operations 2 paths 17 schemas 1 DELETE2 GET1 POST1 PUT

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 Secondary DNS (Peer) 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 5

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

Secondary DNS (Peer) 5
GET
/accounts/{account_id}/secondary_dns/peers
APIs.io Engineering Platform List Peers
secondary-dns-(-peer)-list-peers 1 param → 4XX200
POST
/accounts/{account_id}/secondary_dns/peers
APIs.io Engineering Platform Create Peer
secondary-dns-(-peer)-create-peer 1 param body → 4XX200
DELETE
/accounts/{account_id}/secondary_dns/peers/{peer_id}
APIs.io Engineering Platform Delete Peer
secondary-dns-(-peer)-delete-peer 2 params body → 4XX200
GET
/accounts/{account_id}/secondary_dns/peers/{peer_id}
APIs.io Engineering Platform Peer Details
secondary-dns-(-peer)-peer-details 2 params → 4XX200
PUT
/accounts/{account_id}/secondary_dns/peers/{peer_id}
APIs.io Engineering Platform Update Peer
secondary-dns-(-peer)-update-peer 2 params body → 4XX200

Schemas 17

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

secondary-dns_api-response-collection
object
secondary-dns_account_identifier
string
secondary-dns_components-schemas-name
string
The name of the peer.
secondary-dns_schemas-single_response
secondary-dns_ip
string
IPv4/IPv6 address of primary or secondary nameserver, depending on what zone this peer is linked to. For primary zones this IP defines the IP of the secondary…
secondary-dns_peer
object
6 properties 2 required
secondary-dns_tsig_id
string
TSIG authentication will be used for zone transfer if configured.
secondary-dns_components-schemas-identifier
string
secondary-dns_api-response-single
object
secondary-dns_api-response-common
object
3 properties 3 required
secondary-dns_components-schemas-id_response
secondary-dns_api-response-common-failure
object
4 properties 4 required
secondary-dns_messages
array
secondary-dns_result_info
object
4 properties
secondary-dns_ixfr_enable
boolean
Enable IXFR transfer protocol, default is AXFR. Only applicable to secondary zones.
secondary-dns_port
number
DNS port of primary or secondary nameserver, depending on what zone this peer is linked to.
secondary-dns_schemas-response_collection

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-secondary-dns-peer-api-openapi.yml Raw ↑