Skip to content
Cloudflare API
Start here
API Reference

Tenant Custom Nameservers

List Tenant Custom Nameservers
client.tenantCustomNameservers.get(stringtenantTag, RequestOptionsoptions?): SinglePage<TenantCustomNameserverGetResponse { dns_records, ns_name, status, 2 more } >
GET/tenants/{tenant_tag}/custom_ns
Add Tenant Custom Nameserver
client.tenantCustomNameservers.create(stringtenantTag, TenantCustomNameserverCreateParams { ns_name, ns_set } body, RequestOptionsoptions?): TenantCustomNameserverCreateResponse { dns_records, ns_name, status, 2 more }
POST/tenants/{tenant_tag}/custom_ns
Delete Tenant Custom Nameserver
client.tenantCustomNameservers.delete(stringtenantTag, stringcustomNSId, RequestOptionsoptions?): SinglePage<TenantCustomNameserverDeleteResponse>
DELETE/tenants/{tenant_tag}/custom_ns/{custom_ns_id}
ModelsExpand Collapse
TenantCustomNameserverGetResponse { dns_records, ns_name, status, 2 more }

A single tenant custom nameserver.

dns_records: Array<DNSRecord>

A and AAAA records associated with the nameserver.

type?: "A" | "AAAA"

DNS record type.

One of the following:
"A"
"AAAA"
value?: string

DNS record contents (an IPv4 or IPv6 address).

ns_name: string

The FQDN of the name server.

formathostname
Deprecatedstatus: "moved" | "pending" | "verified"

Verification status of the nameserver.

One of the following:
"moved"
"pending"
"verified"
zone_tag: string

Identifier.

maxLength32
ns_set?: number

The number of the set that this name server belongs to.

maximum5
minimum1
TenantCustomNameserverCreateResponse { dns_records, ns_name, status, 2 more }

A single tenant custom nameserver.

dns_records: Array<DNSRecord>

A and AAAA records associated with the nameserver.

type?: "A" | "AAAA"

DNS record type.

One of the following:
"A"
"AAAA"
value?: string

DNS record contents (an IPv4 or IPv6 address).

ns_name: string

The FQDN of the name server.

formathostname
Deprecatedstatus: "moved" | "pending" | "verified"

Verification status of the nameserver.

One of the following:
"moved"
"pending"
"verified"
zone_tag: string

Identifier.

maxLength32
ns_set?: number

The number of the set that this name server belongs to.

maximum5
minimum1
TenantCustomNameserverDeleteResponse = string

Unused