---
title: Get Account Custom Nameserver Related Zone Metadata
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/go)

[Zones](https://developers.cloudflare.com/api/go/resources/zones)

[Custom Nameservers](https://developers.cloudflare.com/api/go/resources/zones/subresources/custom_nameservers)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Get Account Custom Nameserver Related Zone Metadata

Deprecated: Use \[DNS settings API](https://developers.cloudflare.com/api/resources/dns/subresources/settings/methods/get/) instead.

client.Zones.CustomNameservers.Get(ctx, query) (\*[CustomNameserverGetResponse](<https://developers.cloudflare.com/api/go/resources/zones#(resource)%20zones.custom_nameservers%20%3E%20(model)%20CustomNameserverGetResponse%20%3E%20(schema)>), error)

GET/zones/{zone\_id}/custom\_ns

Get metadata for account-level custom nameservers on a zone.

Deprecated in favor of [Show DNS Settings](https://developers.cloudflare.com/api/operations/dns-settings-for-a-zone-list-dns-settings).

##### Security

<details>

<summary>API Token</summary>



The preferred authorization scheme for interacting with the Cloudflare API. <a href="https://developers.cloudflare.com/fundamentals/api/get-started/create-token/">Create a token</a>.

**Example:**<code>Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY</code>

</details>

<details>

<summary>API Email + API Key</summary>



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

**Example:**<code>X-Auth-Email: user@example.com</code>

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

**Example:**<code>X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194</code>

</details>

##### Accepted Permissions (at least one required)

`Trust and Safety Write``Trust and Safety Read``Zero Trust: PII Read``Zaraz Edit``Zaraz Read``Zaraz Admin``Access: Apps and Policies Revoke``Access: Apps and Policies Write``Access: Apps and Policies Read``Access: Apps and Policies Revoke``Access: Mutual TLS Certificates Write``Access: Organizations, Identity Providers, and Groups Write``Zone Settings Write``Zone Settings Read``Zone Read``DNS Read``Workers Scripts Write``Workers Scripts Read``Zone Write``Workers Routes Write``Workers Routes Read``Stream Write``Stream Read``SSL and Certificates Write``SSL and Certificates Read``Logs Write``Logs Read``Cache Purge``Page Rules Write``Page Rules Read``Load Balancers Write``Load Balancers Read``Firewall Services Write``Firewall Services Read``DNS Write``Apps Write``Analytics Read``Access: Apps and Policies Write``Access: Apps and Policies Read`

##### ParametersExpand Collapse

<details>

<summary>

query CustomNameserverGetParams

</summary>

ZoneID param.Field\[string]

Identifier.

maxLength32

<a href="#(resource)%20zones.custom_nameservers%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20zone_id">Link to this property</a>

</details>

[Link to this property](<#(resource)%20zones.custom_nameservers%20%3E%20(method)%20get%20%3E%20(params)%20default>)

##### ReturnsExpand Collapse

<details>

<summary>

type CustomNameserverGetResponse struct{…}

</summary>

<details>

<summary>

Errors \[]CustomNameserverGetResponseError

</summary>

Code int64

minimum1000

<a href="#(resource)%20zones.custom_nameservers%20%3E%20(model)%20CustomNameserverGetResponse%20%3E%20(schema)%20%3E%20(property)%20errors%20%3E%20(items)%20%3E%20(property)%20code">Link to this property</a>

Message string

<a href="#(resource)%20zones.custom_nameservers%20%3E%20(model)%20CustomNameserverGetResponse%20%3E%20(schema)%20%3E%20(property)%20errors%20%3E%20(items)%20%3E%20(property)%20message">Link to this property</a>

DocumentationURL stringOptional

<a href="#(resource)%20zones.custom_nameservers%20%3E%20(model)%20CustomNameserverGetResponse%20%3E%20(schema)%20%3E%20(property)%20errors%20%3E%20(items)%20%3E%20(property)%20documentation_url">Link to this property</a>

<details>

<summary>

Source CustomNameserverGetResponseErrorsSourceOptional

</summary>

Pointer stringOptional

<a href="#(resource)%20zones.custom_nameservers%20%3E%20(model)%20CustomNameserverGetResponse%20%3E%20(schema)%20%3E%20(property)%20errors%20%3E%20(items)%20%3E%20(property)%20source%20%3E%20(property)%20pointer">Link to this property</a>

</details>

<a href="#(resource)%20zones.custom_nameservers%20%3E%20(model)%20CustomNameserverGetResponse%20%3E%20(schema)%20%3E%20(property)%20errors%20%3E%20(items)%20%3E%20(property)%20source">Link to this property</a>

</details>

<a href="#(resource)%20zones.custom_nameservers%20%3E%20(model)%20CustomNameserverGetResponse%20%3E%20(schema)%20%3E%20(property)%20errors">Link to this property</a>

<details>

<summary>

Messages \[]CustomNameserverGetResponseMessage

</summary>

Code int64

minimum1000

<a href="#(resource)%20zones.custom_nameservers%20%3E%20(model)%20CustomNameserverGetResponse%20%3E%20(schema)%20%3E%20(property)%20messages%20%3E%20(items)%20%3E%20(property)%20code">Link to this property</a>

Message string

<a href="#(resource)%20zones.custom_nameservers%20%3E%20(model)%20CustomNameserverGetResponse%20%3E%20(schema)%20%3E%20(property)%20messages%20%3E%20(items)%20%3E%20(property)%20message">Link to this property</a>

DocumentationURL stringOptional

<a href="#(resource)%20zones.custom_nameservers%20%3E%20(model)%20CustomNameserverGetResponse%20%3E%20(schema)%20%3E%20(property)%20messages%20%3E%20(items)%20%3E%20(property)%20documentation_url">Link to this property</a>

<details>

<summary>

Source CustomNameserverGetResponseMessagesSourceOptional

</summary>

Pointer stringOptional

<a href="#(resource)%20zones.custom_nameservers%20%3E%20(model)%20CustomNameserverGetResponse%20%3E%20(schema)%20%3E%20(property)%20messages%20%3E%20(items)%20%3E%20(property)%20source%20%3E%20(property)%20pointer">Link to this property</a>

</details>

<a href="#(resource)%20zones.custom_nameservers%20%3E%20(model)%20CustomNameserverGetResponse%20%3E%20(schema)%20%3E%20(property)%20messages%20%3E%20(items)%20%3E%20(property)%20source">Link to this property</a>

</details>

<a href="#(resource)%20zones.custom_nameservers%20%3E%20(model)%20CustomNameserverGetResponse%20%3E%20(schema)%20%3E%20(property)%20messages">Link to this property</a>

Success CustomNameserverGetResponseSuccess

Whether the API call was successful.

<a href="#(resource)%20zones.custom_nameservers%20%3E%20(model)%20CustomNameserverGetResponse%20%3E%20(schema)%20%3E%20(property)%20success">Link to this property</a>

Enabled boolOptional

Whether zone uses account-level custom nameservers.

<a href="#(resource)%20zones.custom_nameservers%20%3E%20(model)%20CustomNameserverGetResponse%20%3E%20(schema)%20%3E%20(property)%20enabled">Link to this property</a>

NSSet float64Optional

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

maximum5

minimum1

<a href="#(resource)%20zones.custom_nameservers%20%3E%20(model)%20CustomNameserverGetResponse%20%3E%20(schema)%20%3E%20(property)%20ns_set">Link to this property</a>

<details>

<summary>

ResultInfo CustomNameserverGetResponseResultInfoOptional

</summary>

Count float64Optional

Total number of results for the requested service.

<a href="#(resource)%20zones.custom_nameservers%20%3E%20(model)%20CustomNameserverGetResponse%20%3E%20(schema)%20%3E%20(property)%20result_info%20%3E%20(property)%20count">Link to this property</a>

Page float64Optional

Current page within paginated list of results.

<a href="#(resource)%20zones.custom_nameservers%20%3E%20(model)%20CustomNameserverGetResponse%20%3E%20(schema)%20%3E%20(property)%20result_info%20%3E%20(property)%20page">Link to this property</a>

PerPage float64Optional

Number of results per page of results.

<a href="#(resource)%20zones.custom_nameservers%20%3E%20(model)%20CustomNameserverGetResponse%20%3E%20(schema)%20%3E%20(property)%20result_info%20%3E%20(property)%20per_page">Link to this property</a>

TotalCount float64Optional

Total results available without any search parameters.

<a href="#(resource)%20zones.custom_nameservers%20%3E%20(model)%20CustomNameserverGetResponse%20%3E%20(schema)%20%3E%20(property)%20result_info%20%3E%20(property)%20total_count">Link to this property</a>

TotalPages float64Optional

The number of total pages in the entire result set.

<a href="#(resource)%20zones.custom_nameservers%20%3E%20(model)%20CustomNameserverGetResponse%20%3E%20(schema)%20%3E%20(property)%20result_info%20%3E%20(property)%20total_pages">Link to this property</a>

</details>

<a href="#(resource)%20zones.custom_nameservers%20%3E%20(model)%20CustomNameserverGetResponse%20%3E%20(schema)%20%3E%20(property)%20result_info">Link to this property</a>

</details>

[Link to this property](<#(resource)%20zones.custom_nameservers%20%3E%20(model)%20CustomNameserverGetResponse%20%3E%20(schema)>)

### Get Account Custom Nameserver Related Zone Metadata

Go

HTTPTypeScriptPythonGoTerraform

```
package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/zones"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  customNameserver, err := client.Zones.CustomNameservers.Get(context.TODO(), zones.CustomNameserverGetParams{
    ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", customNameserver.Errors)
}
```

200 example

```
{
  "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,
  "enabled": true,
  "ns_set": 1,
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}
```

##### Returns Examples

200 example

```
{
  "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,
  "enabled": true,
  "ns_set": 1,
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}
```