Overview
Error Handling

Methods

API Documentation (API Version bleed)

Network/DNS/Zone/

DESCRIPTION

DNS allows you to point domain names to IP addresses. Each domain name is represented by a DNS zone, which in turns can contain several records of varying types. For more information about the generals of DNS, refer to Wikipedia or some other resource.

This section of the API contains methods for creating and deleting zones from our DNS system, as well as getting information about what zones we are currently serving for you.

bulkUpdateTTL

URL:

https://api.liquidweb.com/bleed/Network/DNS/Zone/bulkUpdateTTL

Description:

Update all resource records in a zone with the same TTL.

Parameters:

ParameterTypeNotes
idA positive integer value (i.e. 1 and up).* Required if:
  • name is not given
nameA valid forward DNS Zone name.* Required if:
  • id is not given
ttlA positive integer value (i.e. 1 and up).* Required

Returns:

FieldType
recordsAn array of associative arrays containing
 
adminEmailEither: a valid email address.; or a valid admin email for an SOA record.* Optional
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
exchangeA valid hostname (Fully qualified domain name, consisting only of letters, digits and '-')* Optional
expiryA non-negative integer value (i.e. 0 and up).* Optional
fullDataA string.* Optional
idA positive integer value (i.e. 1 and up).
last_updatedA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
minimumA non-negative integer value (i.e. 0 and up).* Optional
nameEither: a valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters); or a valid reverse ipv4 DNS record.; or a valid reverse ipv6 DNS record.; or a valid hostname (Fully qualified domain name, consisting only of letters, digits and '-'); or a wildcard, represented by '*.domain'.
nameserverEither: a valid hostname (Fully qualified domain name, consisting only of letters, digits and '-'); or a valid nameserver in an SOA record.* Optional
portA positive integer value (i.e. 1 and up).* Optional
prioA non-negative integer value (i.e. 0 and up).* Optional
rdataA string.
refreshIntervalA non-negative integer value (i.e. 0 and up).* Optional
regionOverridesAn array of associative arrays containing * Optional
 
rdataA string permitting tabs, carriage returns and newlines
regionA string permitting tabs, carriage returns and newlines
region_idA positive integer value (i.e. 1 and up).
retryA non-negative integer value (i.e. 0 and up).* Optional
serialA positive integer value (i.e. 1 and up).* Optional
targetA valid hostname (Fully qualified domain name, consisting only of letters, digits and '-')* Optional
ttlA positive integer value (i.e. 1 and up).* Optional
typeOne of: 'A', 'AAAA', 'ALIAS', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SRV', 'TXT'
weightA non-negative integer value (i.e. 0 and up).* Optional
zone_idA positive integer value (i.e. 1 and up).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

create

URL:

https://api.liquidweb.com/bleed/Network/DNS/Zone/create

Description:

Add a new DNS zone.

Parameters:

ParameterTypeNotes
add_pbe_recordsA boolean value (0 or 1).
cloudsiteA boolean value (0 or 1).
live_domainA boolean value (0 or 1).
nameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)* Required
no_extraA boolean value (0 or 1).
region_supportA boolean value (0 or 1).
zone_dataAn associative array containing the fields:
 
contactA valid email address.
ipA valid IP address (v4 or v6)
primaryA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
secondaryA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

Returns:

FieldTypeNotes
activeA boolean value (0 or 1).
delegationAn array of a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)* Optional
delegation_checkedA valid date and time in YYYY-MM-DD HH:MM:SS format.* Optional
delegation_statusA string permitting tabs, carriage returns and newlines* Optional
idA positive integer value (i.e. 1 and up).
masterAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
nameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
notified_serialA positive integer value (i.e. 1 and up).* Optional
region_supportA boolean value (0 or 1).* Optional
typeA single word, consisting of only letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

delegation

URL:

https://api.liquidweb.com/bleed/Network/DNS/Zone/delegation

Description:

This method can be used to check if a DNS zone is properly delegated to our nameservers.

Parameters:

ParameterTypeNotes
idA positive integer value (i.e. 1 and up).* Required if:
  • name is not given
nameA valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters)* Required if:
  • id is not given

Returns:

FieldType
delegationA single word, consisting of only letters, digits, and underscores.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

delete

URL:

https://api.liquidweb.com/bleed/Network/DNS/Zone/delete

Description:

Remove a DNS zone.

Parameters:

ParameterTypeNotes
idA positive integer value (i.e. 1 and up).* Required if:
  • name is not given
nameA valid forward DNS Zone name.* Required if:
  • id is not given

Returns:

FieldType
deletedA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

details

URL:

https://api.liquidweb.com/bleed/Network/DNS/Zone/details

Description:

Retrieve details on a particular zone served by our DNS servers.

Parameters:

ParameterTypeNotes
alsowithAn array of The value: 'delegation'
idA positive integer value (i.e. 1 and up).* Required if:
  • name is not given
nameA valid forward DNS Zone name.* Required if:
  • id is not given

Returns:

FieldTypeNotes
activeA boolean value (0 or 1).
delegationAn array of a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)* Optional
delegation_checkedA valid date and time in YYYY-MM-DD HH:MM:SS format.* Optional
delegation_statusA string permitting tabs, carriage returns and newlines* Optional
idA positive integer value (i.e. 1 and up).
masterAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
nameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
notified_serialA positive integer value (i.e. 1 and up).* Optional
region_supportA boolean value (0 or 1).* Optional
typeA single word, consisting of only letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

formatAsBind

URL:

https://api.liquidweb.com/bleed/Network/DNS/Zone/formatAsBind

Description:

Formats the Zone and Records in BIND Format

Parameters:

ParameterTypeNotes
idA valid id number (a positive integer).* Required if:
  • name is not given
nameA valid forward DNS Zone name.* Required if:
  • id is not given

Returns:

FieldType
bind_dataA string permitting tabs, carriage returns and newlines

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

importCPanelZone

URL:

https://api.liquidweb.com/bleed/Network/DNS/Zone/importCPanelZone

Description:

Given a domain and a uniq_id, imports domain information from cPanel and creates requisite records.

Parameters:

ParameterTypeNotes
domainA valid forward DNS Zone name.* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.* Required if:
  • uniq_id is not given
activeA boolean value (0 or 1).
delegationAn array of a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)* Optional
delegation_checkedA valid date and time in YYYY-MM-DD HH:MM:SS format.* Optional
delegation_statusA string permitting tabs, carriage returns and newlines* Optional
idA positive integer value (i.e. 1 and up).
masterAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
nameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
notified_serialA positive integer value (i.e. 1 and up).* Optional
region_supportA boolean value (0 or 1).* Optional
subaccntA valid id number (a positive integer).* Required if:
  • uniq_id is not given
typeA single word, consisting of only letters and digits.
uniq_idA six-character identifier, containing only capital letters and digits.* Optional

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

importZoneFile

URL:

https://api.liquidweb.com/bleed/Network/DNS/Zone/importZoneFile

Description:

Upload a DNS zone file and add the zone.

Parameters:

ParameterTypeNotes
zonefileA string permitting tabs, carriage returns and newlines* Required

Returns:

FieldType
zonesAn array of associative arrays containing
 
accntA valid account number, up to 6 digits in length.* Required if:
  • uniq_id is not given
activeA boolean value (0 or 1).
delegationAn array of a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)* Optional
delegation_checkedA valid date and time in YYYY-MM-DD HH:MM:SS format.* Optional
delegation_statusA string permitting tabs, carriage returns and newlines* Optional
idA positive integer value (i.e. 1 and up).
masterAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
nameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
notified_serialA positive integer value (i.e. 1 and up).* Optional
region_supportA boolean value (0 or 1).* Optional
subaccntA valid id number (a positive integer).* Required if:
  • uniq_id is not given
typeA single word, consisting of only letters and digits.
uniq_idA six-character identifier, containing only capital letters and digits.* Optional

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

list

URL:

https://api.liquidweb.com/bleed/Network/DNS/Zone/list

Description:

Retrieve a list of zones that are served by our DNS servers for your account.

Parameters:

ParameterTypeNotes
delegation_statusOne of: 'BAD_NAMESERVERS', 'CORRECT', 'NXDOMAIN', 'SERVFAIL', 'UNKNOWN'
domainA fragment of a valid domain name, suitable for partial domain searching
order_byAn associative array containing the fields:
 
fieldOne of: 'delegation_status', 'domain'* Required
sortOne of: 'asc', 'desc'* Optional
  • Defaults to: desc
page_numA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 1
page_sizeA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 25

Returns:

FieldType
item_countA non-negative integer value (i.e. 0 and up).
item_totalA non-negative integer value (i.e. 0 and up).
itemsAn array of associative arrays containing
 
activeA boolean value (0 or 1).
delegationAn array of a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)* Optional
delegation_checkedA valid date and time in YYYY-MM-DD HH:MM:SS format.* Optional
delegation_statusA string permitting tabs, carriage returns and newlines* Optional
idA positive integer value (i.e. 1 and up).
masterAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
nameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
notified_serialA positive integer value (i.e. 1 and up).* Optional
region_supportA boolean value (0 or 1).* Optional
typeA single word, consisting of only letters and digits.
page_numA positive integer value (i.e. 1 and up).
page_sizeA positive integer value (i.e. 1 and up).
page_totalA positive integer value (i.e. 1 and up).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

parkableIps

URL:

https://api.liquidweb.com/bleed/Network/DNS/Zone/parkableIps

Description:

Returns a list of IPs that are valid destinations for A records to be created at the time of creating the zone.

Parameters:

No Values Defined

Returns:

FieldType
itemsAn array of associative arrays containing
 
ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
labelA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters and digits.
uniq_idA six-character identifier, containing only capital letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

replaceMXForPBE

URL:

https://api.liquidweb.com/bleed/Network/DNS/Zone/replaceMXForPBE

Description:

Replaces MX records on a given zone with the appropriate MX Records for Premium Business Email (PBE)

Parameters:

ParameterTypeNotes
idA valid id number (a positive integer).* Required if:
  • name is not given
nameA valid forward DNS Zone name.* Required if:
  • id is not given

Returns:

FieldType
recordsAn array of associative arrays containing
 
adminEmailEither: a valid email address.; or a valid admin email for an SOA record.* Optional
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
exchangeA valid hostname (Fully qualified domain name, consisting only of letters, digits and '-')* Optional
expiryA non-negative integer value (i.e. 0 and up).* Optional
fullDataA string.* Optional
idA positive integer value (i.e. 1 and up).
last_updatedA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
minimumA non-negative integer value (i.e. 0 and up).* Optional
nameEither: a valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters); or a valid reverse ipv4 DNS record.; or a valid reverse ipv6 DNS record.; or a valid hostname (Fully qualified domain name, consisting only of letters, digits and '-'); or a wildcard, represented by '*.domain'.
nameserverEither: a valid hostname (Fully qualified domain name, consisting only of letters, digits and '-'); or a valid nameserver in an SOA record.* Optional
portA positive integer value (i.e. 1 and up).* Optional
prioA non-negative integer value (i.e. 0 and up).* Optional
rdataA string.
refreshIntervalA non-negative integer value (i.e. 0 and up).* Optional
regionOverridesAn array of associative arrays containing * Optional
 
rdataA string permitting tabs, carriage returns and newlines
regionA string permitting tabs, carriage returns and newlines
region_idA positive integer value (i.e. 1 and up).
retryA non-negative integer value (i.e. 0 and up).* Optional
serialA positive integer value (i.e. 1 and up).* Optional
targetA valid hostname (Fully qualified domain name, consisting only of letters, digits and '-')* Optional
ttlA positive integer value (i.e. 1 and up).* Optional
typeOne of: 'A', 'AAAA', 'ALIAS', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SRV', 'TXT'
weightA non-negative integer value (i.e. 0 and up).* Optional
zone_idA positive integer value (i.e. 1 and up).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

summary

URL:

https://api.liquidweb.com/bleed/Network/DNS/Zone/summary

Description:

Retrieve a summary on a particular DNS zone.

Parameters:

ParameterTypeNotes
nameA valid forward DNS Zone name.* Required

Returns:

FieldTypeNotes
activeA boolean value (0 or 1).
delegationAn array of a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)* Optional
delegation_checkedA valid date and time in YYYY-MM-DD HH:MM:SS format.* Optional
delegation_statusA string permitting tabs, carriage returns and newlines* Optional
idA positive integer value (i.e. 1 and up).
masterAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
nameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
notified_serialA positive integer value (i.e. 1 and up).* Optional
recordsAn associative array containing the fields:
 
aAn array of associative arrays containing * Optional
 
adminEmailEither: a valid email address.; or a valid admin email for an SOA record.* Optional
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
exchangeA valid hostname (Fully qualified domain name, consisting only of letters, digits and '-')* Optional
expiryA non-negative integer value (i.e. 0 and up).* Optional
fullDataA string.* Optional
idA positive integer value (i.e. 1 and up).
last_updatedA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
minimumA non-negative integer value (i.e. 0 and up).* Optional
nameEither: a valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters); or a valid reverse ipv4 DNS record.; or a valid reverse ipv6 DNS record.; or a valid hostname (Fully qualified domain name, consisting only of letters, digits and '-'); or a wildcard, represented by '*.domain'.
nameserverEither: a valid hostname (Fully qualified domain name, consisting only of letters, digits and '-'); or a valid nameserver in an SOA record.* Optional
portA positive integer value (i.e. 1 and up).* Optional
prioA non-negative integer value (i.e. 0 and up).* Optional
rdataA string.
refreshIntervalA non-negative integer value (i.e. 0 and up).* Optional
regionOverridesAn array of associative arrays containing * Optional
 
rdataA string permitting tabs, carriage returns and newlines
regionA string permitting tabs, carriage returns and newlines
region_idA positive integer value (i.e. 1 and up).
retryA non-negative integer value (i.e. 0 and up).* Optional
serialA positive integer value (i.e. 1 and up).* Optional
targetA valid hostname (Fully qualified domain name, consisting only of letters, digits and '-')* Optional
ttlA positive integer value (i.e. 1 and up).* Optional
typeOne of: 'A', 'AAAA', 'ALIAS', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SRV', 'TXT'
weightA non-negative integer value (i.e. 0 and up).* Optional
zone_idA positive integer value (i.e. 1 and up).
mxAn array of associative arrays containing * Optional
 
adminEmailEither: a valid email address.; or a valid admin email for an SOA record.* Optional
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
exchangeA valid hostname (Fully qualified domain name, consisting only of letters, digits and '-')* Optional
expiryA non-negative integer value (i.e. 0 and up).* Optional
fullDataA string.* Optional
idA positive integer value (i.e. 1 and up).
last_updatedA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
minimumA non-negative integer value (i.e. 0 and up).* Optional
nameEither: a valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters); or a valid reverse ipv4 DNS record.; or a valid reverse ipv6 DNS record.; or a valid hostname (Fully qualified domain name, consisting only of letters, digits and '-'); or a wildcard, represented by '*.domain'.
nameserverEither: a valid hostname (Fully qualified domain name, consisting only of letters, digits and '-'); or a valid nameserver in an SOA record.* Optional
portA positive integer value (i.e. 1 and up).* Optional
prioA non-negative integer value (i.e. 0 and up).* Optional
rdataA string.
refreshIntervalA non-negative integer value (i.e. 0 and up).* Optional
regionOverridesAn array of associative arrays containing * Optional
 
rdataA string permitting tabs, carriage returns and newlines
regionA string permitting tabs, carriage returns and newlines
region_idA positive integer value (i.e. 1 and up).
retryA non-negative integer value (i.e. 0 and up).* Optional
serialA positive integer value (i.e. 1 and up).* Optional
targetA valid hostname (Fully qualified domain name, consisting only of letters, digits and '-')* Optional
ttlA positive integer value (i.e. 1 and up).* Optional
typeOne of: 'A', 'AAAA', 'ALIAS', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SRV', 'TXT'
weightA non-negative integer value (i.e. 0 and up).* Optional
zone_idA positive integer value (i.e. 1 and up).
nsAn array of associative arrays containing * Optional
 
adminEmailEither: a valid email address.; or a valid admin email for an SOA record.* Optional
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
exchangeA valid hostname (Fully qualified domain name, consisting only of letters, digits and '-')* Optional
expiryA non-negative integer value (i.e. 0 and up).* Optional
fullDataA string.* Optional
idA positive integer value (i.e. 1 and up).
last_updatedA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
minimumA non-negative integer value (i.e. 0 and up).* Optional
nameEither: a valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters); or a valid reverse ipv4 DNS record.; or a valid reverse ipv6 DNS record.; or a valid hostname (Fully qualified domain name, consisting only of letters, digits and '-'); or a wildcard, represented by '*.domain'.
nameserverEither: a valid hostname (Fully qualified domain name, consisting only of letters, digits and '-'); or a valid nameserver in an SOA record.* Optional
portA positive integer value (i.e. 1 and up).* Optional
prioA non-negative integer value (i.e. 0 and up).* Optional
rdataA string.
refreshIntervalA non-negative integer value (i.e. 0 and up).* Optional
regionOverridesAn array of associative arrays containing * Optional
 
rdataA string permitting tabs, carriage returns and newlines
regionA string permitting tabs, carriage returns and newlines
region_idA positive integer value (i.e. 1 and up).
retryA non-negative integer value (i.e. 0 and up).* Optional
serialA positive integer value (i.e. 1 and up).* Optional
targetA valid hostname (Fully qualified domain name, consisting only of letters, digits and '-')* Optional
ttlA positive integer value (i.e. 1 and up).* Optional
typeOne of: 'A', 'AAAA', 'ALIAS', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SRV', 'TXT'
weightA non-negative integer value (i.e. 0 and up).* Optional
zone_idA positive integer value (i.e. 1 and up).
txtAn array of associative arrays containing * Optional
 
adminEmailEither: a valid email address.; or a valid admin email for an SOA record.* Optional
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
exchangeA valid hostname (Fully qualified domain name, consisting only of letters, digits and '-')* Optional
expiryA non-negative integer value (i.e. 0 and up).* Optional
fullDataA string.* Optional
idA positive integer value (i.e. 1 and up).
last_updatedA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
minimumA non-negative integer value (i.e. 0 and up).* Optional
nameEither: a valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters); or a valid reverse ipv4 DNS record.; or a valid reverse ipv6 DNS record.; or a valid hostname (Fully qualified domain name, consisting only of letters, digits and '-'); or a wildcard, represented by '*.domain'.
nameserverEither: a valid hostname (Fully qualified domain name, consisting only of letters, digits and '-'); or a valid nameserver in an SOA record.* Optional
portA positive integer value (i.e. 1 and up).* Optional
prioA non-negative integer value (i.e. 0 and up).* Optional
rdataA string.
refreshIntervalA non-negative integer value (i.e. 0 and up).* Optional
regionOverridesAn array of associative arrays containing * Optional
 
rdataA string permitting tabs, carriage returns and newlines
regionA string permitting tabs, carriage returns and newlines
region_idA positive integer value (i.e. 1 and up).
retryA non-negative integer value (i.e. 0 and up).* Optional
serialA positive integer value (i.e. 1 and up).* Optional
targetA valid hostname (Fully qualified domain name, consisting only of letters, digits and '-')* Optional
ttlA positive integer value (i.e. 1 and up).* Optional
typeOne of: 'A', 'AAAA', 'ALIAS', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SRV', 'TXT'
weightA non-negative integer value (i.e. 0 and up).* Optional
zone_idA positive integer value (i.e. 1 and up).
region_supportA boolean value (0 or 1).* Optional
typeA single word, consisting of only letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

update

URL:

https://api.liquidweb.com/bleed/Network/DNS/Zone/update

Description:

Update the zone features.

Parameters:

ParameterTypeNotes
DNSRegionSupportA boolean value (0 or 1).
idA positive integer value (i.e. 1 and up).* Required if:
  • name is not given
nameA valid forward DNS Zone name.* Required if:
  • id is not given

Returns:

FieldTypeNotes
activeA boolean value (0 or 1).
delegationAn array of a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)* Optional
delegation_checkedA valid date and time in YYYY-MM-DD HH:MM:SS format.* Optional
delegation_statusA string permitting tabs, carriage returns and newlines* Optional
idA positive integer value (i.e. 1 and up).
masterAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
nameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
notified_serialA positive integer value (i.e. 1 and up).* Optional
region_supportA boolean value (0 or 1).* Optional
typeA single word, consisting of only letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types