Nameservers

Several API functions use the Nameservers structure as a parameter to specify a list of nameservers and their potential IP

 

List

The API filters parameter accepts an array of nameserver objects, allowing from 0 to 13 nameservers to be applied.

Exemple :

{
    "1": {
        "name": "ns1.netim.net"
    },
    "2": {
        "name": "ns2.netim.net"
    },
    "3": {
        "name": "ns3.my-domain.net",
        "IPv4": "192.168.1.1 "
    },
    "4": {
        "name": "ns4.my-domain.net",
        "IPv6": "2001:0db8:3c4d:0015:0000:d234::3eee:0000"
    }
}

 

Structure

Each list of nameservers consists of:

Value

Type

Length

Description

nameservers

array

0-n

List of nameserver to be applied

nameservers.{number}

array

1-3

Array containing nameserver information

{number}

int

1-13

Nameserver number

nameservers.{number}.name

string

0-n

Server name

nameservers.{number}.IPv4

string

0-n

Server IPv4 (optional)

nameservers.{number}.IPv6

string

0-n

Server IPv6 (optional)

Examples :

Comparison

Example

Name only

"{number}": {
    "name": "{server name}"
}

Using IPv4

"{number}": {
    "name": "{server name}",
    "IPv4": "{server IPv4}"
}

Using IPv6

"{number}": {
    "name": "{server name}",
    "IPv6": "{server IPv6}"
}

 

References

The Nameservers structure is used by the following functions. For more information, see the corresponding pages.