API Reference

Zones

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Custom Nameservers

Get Account Custom Nameserver Related Zone Metadata

Deprecated

client.zones.customNameservers.get(CustomNameserverGetParams { zone_id } params, RequestOptionsoptions?): CustomNameserverGetResponse { errors, messages, success, 3 more }

GET/zones/{zone_id}/custom_ns

Set Account Custom Nameserver Related Zone Metadata

Deprecated

client.zones.customNameservers.update(CustomNameserverUpdateParams { zone_id, enabled, ns_set } params, RequestOptionsoptions?): SinglePage<CustomNameserverUpdateResponse>

PUT/zones/{zone_id}/custom_ns

ModelsExpand Collapse

CustomNameserverGetResponse { errors, messages, success, 3 more }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

enabled?: boolean

Whether zone uses account-level custom nameservers.

ns_set?: number

The number of the name server set to assign to the zone.

maximum5

minimum1

result_info?: ResultInfo { count, page, per_page, total_count }

count?: number

Total number of results for the requested service.

page?: number

Current page within paginated list of results.

per_page?: number

Number of results per page of results.

total_count?: number

Total results available without any search parameters.

CustomNameserverUpdateResponse = string

Unused