Show DNS Settings

client.dns.settings.zone.get(, ?): ZoneGetResponse { flatten_all_cnames, foundation_dns, internal_dns, 6 more }

GET/zones/{zone_id}/dns_settings

Show DNS settings for a zone

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Zone DNS Settings WriteZone DNS Settings ReadDNS ReadDNS Write

ParametersExpand Collapse

params: ZoneGetParams { zone_id }

zone_id: string

Identifier.

maxLength32

ReturnsExpand Collapse

ZoneGetResponse { flatten_all_cnames, foundation_dns, internal_dns, 6 more }

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.

foundation_dns: boolean

Whether to enable Foundation DNS Advanced Nameservers on the zone.

internal_dns: InternalDNS { reference_zone_id }

Settings for this internal zone.

reference_zone_id?: string

The ID of the zone to fallback to.

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 zone apex during outbound zone transfers.

nameservers: Nameservers { type, ns_set }

Settings determining the nameservers through which the zone should be available.

type: "cloudflare.standard" | "custom.account" | "custom.tenant" | "custom.zone"

Nameserver type

One of the following:

"cloudflare.standard"

"custom.account"

"custom.tenant"

"custom.zone"

ns_set?: number

Configured nameserver set to be used for this zone

maximum5

minimum1

ns_ttl: number

The time to live (TTL) of the zone's nameserver (NS) records.

maximum86400

minimum30

secondary_overrides: boolean

Allows a Secondary DNS zone to use (proxied) override records and CNAME flattening at the zone apex.

soa: SOA { expire, min_ttl, mname, 4 more }

Components of the zone's SOA record.

expire?: number

Time in seconds of being unable to query the primary server after which secondary servers should stop serving the zone.

maximum2419200

minimum86400

min_ttl?: number

The time to live (TTL) for negative caching of records within the zone.

maximum86400

minimum60

mname?: string | null

The primary nameserver, which may be used for outbound zone transfers. If null, a Cloudflare-assigned value will be used.

refresh?: number

Time in seconds after which secondary servers should re-check the SOA record to see if the zone has been updated.

maximum86400

minimum600

retry?: number

Time in seconds after which secondary servers should retry queries after the primary server was unresponsive.

maximum86400

minimum600

rname?: string

The email address of the zone administrator, with the first label representing the local part of the email address.

ttl?: number

The time to live (TTL) of the SOA record itself.

maximum86400

minimum300

zone_mode: "standard" | "cdn_only" | "dns_only"

Whether the zone mode is a regular or CDN/DNS only zone.

One of the following:

"standard"

"cdn_only"

"dns_only"

Show DNS Settings

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const zone = await client.dns.settings.zone.get({ zone_id: '023e105f4ecef8ad9ca31a8372d0c353' });

console.log(zone.multi_provider);

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "flatten_all_cnames": false,
    "foundation_dns": false,
    "internal_dns": {
      "reference_zone_id": "reference_zone_id"
    },
    "multi_provider": false,
    "nameservers": {
      "type": "cloudflare.standard",
      "ns_set": 1
    },
    "ns_ttl": 86400,
    "secondary_overrides": false,
    "soa": {
      "expire": 604800,
      "min_ttl": 1800,
      "mname": "kristina.ns.cloudflare.com",
      "refresh": 10000,
      "retry": 2400,
      "rname": "admin.example.com",
      "ttl": 3600
    },
    "zone_mode": "dns_only"
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "flatten_all_cnames": false,
    "foundation_dns": false,
    "internal_dns": {
      "reference_zone_id": "reference_zone_id"
    },
    "multi_provider": false,
    "nameservers": {
      "type": "cloudflare.standard",
      "ns_set": 1
    },
    "ns_ttl": 86400,
    "secondary_overrides": false,
    "soa": {
      "expire": 604800,
      "min_ttl": 1800,
      "mname": "kristina.ns.cloudflare.com",
      "refresh": 10000,
      "retry": 2400,
      "rname": "admin.example.com",
      "ttl": 3600
    },
    "zone_mode": "dns_only"
  }
}