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/Zone/
DESCRIPTION
A zone is a high level chunk of infrastructure. This class provides methods for listing zones.
details
URL:
https://api.liquidweb.com/v1/Network/Zone/details
Description:
Returns details of a given network zone by its name or id field.
Parameters:
Parameter | Type | Notes |
---|---|---|
id | A positive integer value (i.e. 1 and up). | * Required |
Returns:
Field | Type | |||||||
---|---|---|---|---|---|---|---|---|
id | A positive integer value (i.e. 1 and up). | |||||||
is_default | A boolean value (0 or 1). | |||||||
name | A string. | |||||||
region | An associative array containing the fields: | |||||||
| ||||||||
status | A single word, consisting of only letters and digits. | |||||||
valid_source_hvs | An associative array containing the fields: | |||||||
|
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
list
URL:
https://api.liquidweb.com/v1/Network/Zone/list
Description:
Returns a list of zones.
Parameters:
Parameter | Type | Notes |
---|---|---|
page_num | A positive integer value (i.e. 1 and up). | * Optional
|
page_size | A positive integer value (i.e. 1 and up). | * Optional
|
region | A string permitting tabs, carriage returns and newlines |
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
setDefault
URL:
https://api.liquidweb.com/v1/Network/Zone/setDefault
Description:
Sets the default zone for an account.
Parameters:
Parameter | Type | Notes |
---|---|---|
id | A non-negative integer value (i.e. 0 and up). | * Required |
Returns:
Field | Type |
---|---|
default_zone | A positive integer value (i.e. 1 and up). |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types