# List Vanity Nameservers

Lists all vanity nameserver hostnames configured for a domain.

Endpoint: GET /core/v1/domains/{domainName}/vanity_nameservers
Version: 1.3.1
Security: BasicAuth

## Path parameters:

  - `domainName` (string, required)
    The domain name to list vanity nameservers for.
    Example: "example.com"

## Query parameters:

  - `perPage` (integer)
    The number of records to return per page. Defaults to 1000.
    Example: 50

  - `page` (integer)
    The page number to return.
    Example: 2

## Response 200 fields (application/json):

  - `lastPage` (integer,null)
    LastPage is the identifier for the final page of results. It is only populated if there is another page of results after the current page. If no further pages exist, this field will be null.
    Example: 5

  - `nextPage` (integer,null)
    NextPage is the identifier for the next page of results. It is only populated if there is another page of results after the current page. If no further pages exist, this field will be null.
    Example: 2

  - `vanityNameservers` (array, required)
    VanityNameservers is the list of vanity nameservers associated with the domain. If no vanity nameservers are configured, this will be an empty array.
    Example: []

  - `vanityNameservers.domainName` (string, required)
    DomainName is the root domain for which this vanity nameserver is created. For example, if the hostname is 'ns1.example.com', the domainName would be 'example.com'.
    Example: "example.com"

  - `vanityNameservers.hostname` (string, required)
    Hostname is the fully qualified domain name (FQDN) of the vanity nameserver. It must be a subdomain of the domain specified in 'domainName'.
    Example: "ns1.example.com"

  - `vanityNameservers.ips` (array, required)
    IPs is a list of IP addresses that are used for glue records for this vanity nameserver. These should be valid IPv4 or IPv6 addresses.
    Example: ["192.168.1.1","2001:0db8:85a3:0000:0000:8a2e:0370:7334"]

## Response 400 fields (application/json):

  - `message` (string)
    A human-readable message providing more details about the error
    Example: "Bad Request"

  - `details` (string,null)
    Additional context or information about the error
    Example: "'domainName' cannot be null"

## Response 403 fields (application/json):

  - `message` (string, required)
    A human-readable message providing more details about the error
    Example: "Permission denied"

  - `details` (string,null)
    Additional context or information about the error
    Example: "Failed authentication"

## Response 404 fields (application/json):

  - `message` (string, required)
    A human-readable message providing more details about the error
    Example: "Not Found"

  - `details` (string,null)
    Additional context or information about the error
    Example: "The requested domain does not exist."

## Response 429 fields (application/json):

  - `message` (string)
    A human-readable message providing more details about the error
    Example: "Rate Limit Exceeded"

## Response 500 fields (application/json):

  - `message` (string, required)
    A human-readable message providing more details about the error.
    Example: "Internal Server Error"

  - `details` (string,null)
    Additional context or information about the error.
    Example: "Something went wrong."