List Account Custom Nameservers

client.CustomNameservers.Get(ctx, query) (*SinglePage[CustomNameserver], error)

GET/accounts/{account_id}/custom_ns

List an account's custom nameservers.

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)

Account Settings WriteAccount Settings Read

ParametersExpand Collapse

query CustomNameserverGetParams

AccountID param.Field[string]

Account identifier tag.

maxLength32

ReturnsExpand Collapse

type CustomNameserver struct{…}

A single account custom nameserver.

DNSRecords []CustomNameserverDNSRecord

A and AAAA records associated with the nameserver.

Type CustomNameserverDNSRecordsTypeoptional

DNS record type.

One of the following:

const CustomNameserverDNSRecordsTypeA CustomNameserverDNSRecordsType = "A"

const CustomNameserverDNSRecordsTypeAAAA CustomNameserverDNSRecordsType = "AAAA"

Value stringoptional

DNS record contents (an IPv4 or IPv6 address).

NSName string

The FQDN of the name server.

formathostname

DeprecatedStatus CustomNameserverStatus

Verification status of the nameserver.

One of the following:

const CustomNameserverStatusMoved CustomNameserverStatus = "moved"

const CustomNameserverStatusPending CustomNameserverStatus = "pending"

const CustomNameserverStatusVerified CustomNameserverStatus = "verified"

ZoneTag string

Identifier.

maxLength32

NSSet float64optional

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

maximum5

minimum1

List Account Custom Nameservers

package main

import (
  "context"
  "fmt"

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

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  page, err := client.CustomNameservers.Get(context.TODO(), custom_nameservers.CustomNameserverGetParams{
    AccountID: cloudflare.F("372e67954025e0ba6aaa6d586b9e0b59"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "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": [
    {
      "dns_records": [
        {
          "type": "A",
          "value": "1.1.1.1"
        }
      ],
      "ns_name": "ns1.example.com",
      "status": "verified",
      "zone_tag": "023e105f4ecef8ad9ca31a8372d0c353",
      "ns_set": 1
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}

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": [
    {
      "dns_records": [
        {
          "type": "A",
          "value": "1.1.1.1"
        }
      ],
      "ns_name": "ns1.example.com",
      "status": "verified",
      "zone_tag": "023e105f4ecef8ad9ca31a8372d0c353",
      "ns_set": 1
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}