hello,
Overview
Error Handling
Error Handling
Methods
- Account/Auth/
- Account/SSH/Key/
- Billing/Invoice/
- Billing/Payment/
- Monitoring/Bandwidth/
- Monitoring/Load/
- Monitoring/Services/
- Network/DNS/Domain/
- Network/DNS/Record/
- Network/DNS/Reverse/
- Network/DNS/Zone/
- Network/Firewall/
- Network/Firewall/Ruleset/
- Network/IP/
- Network/LoadBalancer/
- Network/Pool/
- Network/Private/
- Network/Zone/
- Notifications/
- Order/AddOn/
- Product/
- Server/
- Server/VirtualDomain/
- Storage/Block/Cluster/
- Storage/Block/Volume/
- Storm/Backup/
- Storm/Config/
- Storm/IP/Pool/
- Storm/Image/
- Storm/Server/
- Storm/Template/
- Support/Alert/
- Utilities/Info/
- VIP/
- VPN/
API Documentation (API Version v1)
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.
create
URL:
https://api.liquidweb.com/v1/Network/DNS/Zone/create
Description:
Add a new DNS zone.
Parameters:
| Parameter | Type | Notes | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| add_pbe_records | A boolean value (0 or 1). | |||||||||
| cloudsite | A boolean value (0 or 1). | |||||||||
| live_domain | A boolean value (0 or 1). | |||||||||
| name | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | * Required | ||||||||
| no_extra | A boolean value (0 or 1). | |||||||||
| region_support | A boolean value (0 or 1). | |||||||||
| zone_data | An associative array containing the fields: | |||||||||
| ||||||||||
Returns:
| Field | Type | Notes |
|---|---|---|
| active | A boolean value (0 or 1). | |
| delegation | An array of a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | * Optional |
| delegation_checked | A valid date and time in YYYY-MM-DD HH:MM:SS format. | * Optional |
| delegation_status | A string permitting tabs, carriage returns and newlines | * Optional |
| id | A positive integer value (i.e. 1 and up). | |
| master | An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1) | |
| name | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | |
| notified_serial | A positive integer value (i.e. 1 and up). | * Optional |
| region_support | A boolean value (0 or 1). | * Optional |
| type | A 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/v1/Network/DNS/Zone/delegation
Description:
This method can be used to check if a DNS zone is properly delegated to our nameservers.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| id | A positive integer value (i.e. 1 and up). | * Required if:
|
| name | A valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters) | * Required if:
|
Returns:
| Field | Type |
|---|---|
| delegation | A 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/v1/Network/DNS/Zone/delete
Description:
Remove a DNS zone.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| id | A positive integer value (i.e. 1 and up). | * Required if:
|
| name | A valid forward DNS Zone name. | * Required if:
|
Returns:
| Field | Type |
|---|---|
| deleted | A 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/v1/Network/DNS/Zone/details
Description:
Retrieve details on a particular zone served by our DNS servers.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| alsowith | An array of The value: 'delegation' | |
| id | A positive integer value (i.e. 1 and up). | * Required if:
|
| name | A valid forward DNS Zone name. | * Required if:
|
Returns:
| Field | Type | Notes |
|---|---|---|
| active | A boolean value (0 or 1). | |
| delegation | An array of a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | * Optional |
| delegation_checked | A valid date and time in YYYY-MM-DD HH:MM:SS format. | * Optional |
| delegation_status | A string permitting tabs, carriage returns and newlines | * Optional |
| id | A positive integer value (i.e. 1 and up). | |
| master | An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1) | |
| name | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | |
| notified_serial | A positive integer value (i.e. 1 and up). | * Optional |
| region_support | A boolean value (0 or 1). | * Optional |
| type | A single word, consisting of only letters and digits. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
list
URL:
https://api.liquidweb.com/v1/Network/DNS/Zone/list
Description:
Retrieve a list of zones that are served by our DNS servers for your account.
Parameters:
| Parameter | Type | Notes | ||||||
|---|---|---|---|---|---|---|---|---|
| delegation_status | One of: 'BAD_NAMESERVERS', 'CORRECT', 'NXDOMAIN', 'SERVFAIL', 'UNKNOWN' | |||||||
| domain | A fragment of a valid domain name, suitable for partial domain searching | |||||||
| order_by | An associative array containing the fields: | |||||||
| ||||||||
| page_num | A positive integer value (i.e. 1 and up). | * Optional
| ||||||
| page_size | A positive integer value (i.e. 1 and up). | * Optional
| ||||||
Returns:
| Field | Type | |||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| item_count | A non-negative integer value (i.e. 0 and up). | |||||||||||||||||||||||||||||||
| item_total | A non-negative integer value (i.e. 0 and up). | |||||||||||||||||||||||||||||||
| items | An array of associative arrays containing | |||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||
| page_num | A positive integer value (i.e. 1 and up). | |||||||||||||||||||||||||||||||
| page_size | A positive integer value (i.e. 1 and up). | |||||||||||||||||||||||||||||||
| page_total | A positive integer value (i.e. 1 and up). | |||||||||||||||||||||||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
update
URL:
https://api.liquidweb.com/v1/Network/DNS/Zone/update
Description:
Update the zone features.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| DNSRegionSupport | A boolean value (0 or 1). | |
| id | A positive integer value (i.e. 1 and up). | * Required if:
|
| name | A valid forward DNS Zone name. | * Required if:
|
Returns:
| Field | Type | Notes |
|---|---|---|
| active | A boolean value (0 or 1). | |
| delegation | An array of a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | * Optional |
| delegation_checked | A valid date and time in YYYY-MM-DD HH:MM:SS format. | * Optional |
| delegation_status | A string permitting tabs, carriage returns and newlines | * Optional |
| id | A positive integer value (i.e. 1 and up). | |
| master | An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1) | |
| name | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | |
| notified_serial | A positive integer value (i.e. 1 and up). | * Optional |
| region_support | A boolean value (0 or 1). | * Optional |
| type | A single word, consisting of only letters and digits. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
