custom_nameservers
Creates, updates, deletes, gets or lists a custom_nameservers resource.
Overview
| Name | custom_nameservers |
| Type | Resource |
| Id | cloudflare.zones.custom_nameservers |
Fields
The following fields are returned by SELECT queries:
- list
Get Account Custom Nameserver Related Zone Metadata response
| Name | Datatype | Description |
|---|---|---|
enabled | boolean | Whether zone uses account-level custom nameservers. |
errors | array | |
messages | array | |
ns_set | number | The number of the name server set to assign to the zone. |
result_info | object | |
success | boolean | Whether the API call was successful. (true) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | zone_id | Get metadata for account-level custom nameservers on a zone. Deprecated in favor of Show DNS Settings. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
zone_id | string | The Cloudflare zone ID. |
SELECT examples
- list
Get metadata for account-level custom nameservers on a zone. Deprecated in favor of Show DNS Settings.
SELECT
enabled,
errors,
messages,
ns_set,
result_info,
success
FROM cloudflare.zones.custom_nameservers
WHERE zone_id = '{{ zone_id }}' -- required
;