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 DNS Settings for an Account API

The DNS Settings for an Account API from APIs.io Engineering Platform — 1 operation(s) for dns settings for an account.

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

2 operations 1 paths 16 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 DNS Settings for an Account 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.

DNS Settings for an Account 2
GET
/accounts/{account_id}/dns_settings
APIs.io Engineering Platform Show DNS Settings
dns-settings-for-an-account-list-dns-settings 1 param → 4XX200
PATCH
/accounts/{account_id}/dns_settings
APIs.io Engineering Platform Update DNS Settings
dns-settings-for-an-account-update-dns-settings 1 param body → 4XX200

Schemas 16

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

dns-settings_api-response-single
object
dns-settings_secondary_overrides
boolean
Allows a Secondary DNS zone to use (proxied) override records and CNAME flattening at the zone apex.
dns-settings_foundation_dns
boolean
Whether to enable Foundation DNS Advanced Nameservers on the zone.
dns-settings_ns_ttl
number
The time to live (TTL) of the zone's nameserver (NS) records.
dns-settings_multi_provider
boolean
Whether to enable multi-provider DNS, which causes Cloudflare to activate the zone even when non-Cloudflare NS records exist, and to respect NS records at the…
dns-settings_zone_mode
string
Whether the zone mode is a regular or CDN/DNS only zone.
dns-settings_dns-settings
object
8 properties
dns-settings_account_settings
object
1 property
dns-settings_soa
object
Components of the zone's SOA record.
7 properties 7 required
dns-settings_messages
array
dns-settings_identifier
string
Identifier
dns-settings_api-response-common-failure
object
4 properties 4 required
dns-settings_nameservers
object
Settings determining the nameservers through which the zone should be available.
1 property 1 required
dns-settings_dns_response_single
dns-settings_api-response-common
object
3 properties 3 required
dns-settings_flatten_all_cnames
boolean
Whether to flatten all CNAME records in the zone. Note that, due to DNS limitations, a CNAME record at the zone apex will always be flattened.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-dns-settings-for-an-account-api-openapi.yml Raw ↑