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 Account-Level Custom Nameservers API

The Account-Level Custom Nameservers API from APIs.io Engineering Platform — 3 operation(s) for account-level custom nameservers.

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

4 operations 3 paths 16 schemas 1 DELETE2 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 Account-Level Custom Nameservers 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 4

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

Account-Level Custom Nameservers 4
GET
/accounts/{account_id}/custom_ns
APIs.io Engineering Platform List Account Custom Nameservers
account-level-custom-nameservers-list-account-custom-nameservers 1 param → 4XX200
POST
/accounts/{account_id}/custom_ns
APIs.io Engineering Platform Add Account Custom Nameserver
account-level-custom-nameservers-add-account-custom-nameserver 1 param body → 4XX200
DELETE
/accounts/{account_id}/custom_ns/{custom_ns_id}
APIs.io Engineering Platform Delete Account Custom Nameserver
account-level-custom-nameservers-delete-account-custom-nameserver 2 params body → 4XX200
GET
/accounts/{account_id}/custom_ns/availability
APIs.io Engineering Platform Get Eligible Zones for Account Custom Nameservers
account-level-custom-nameservers-get-eligible-zones-for-account-custom-nameservers 1 param → 4XX200

Schemas 16

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

dns-custom-nameservers_result_info
object
4 properties
dns-custom-nameservers_messages
array
dns-custom-nameservers_api-response-collection
object
dns-custom-nameservers_acns_response_collection
dns-custom-nameservers_empty_response
dns-custom-nameservers_acns_response_single
dns-custom-nameservers_ns_name
string
The FQDN of the name server.
dns-custom-nameservers_api-response-common
object
3 properties 3 required
dns-custom-nameservers_CustomNSInput
object
2 properties 1 required
dns-custom-nameservers_identifier
string
Account identifier tag.
dns-custom-nameservers_api-response-single
object
dns-custom-nameservers_schemas-identifier
string
Identifier
dns-custom-nameservers_ns_set
number
The number of the set that this name server belongs to.
dns-custom-nameservers_api-response-common-failure
object
4 properties 4 required
dns-custom-nameservers_CustomNS
object
A single account custom nameserver.
5 properties 4 required
dns-custom-nameservers_availability_response

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-account-level-custom-nameservers-api-openapi.yml Raw ↑