Error Handling
Methods
- Account/Auth/
- Account/SSH/Key/
- Billing/Invoice/
- Billing/Payment/
- Cloud/Backup/
- Cloud/Config/
- Cloud/IP/Pool/
- Cloud/Image/
- Cloud/Server/
- Cloud/Template/
- 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/
- Support/Alert/
- Utilities/Info/
- VIP/
- VPN/
API Documentation (API Version v1)
Cloud/Config/
DESCRIPTION
The list of available cloud (Storm) server configurations is found here.
details
URL:
https://api.liquidweb.com/v1/Cloud/Config/details
Description:
Get information about a specific config.
Here's a rundown of what those fields mean:
active: a flag indicating whether this server configuration is currently active available: a flag indicating whether any machines are available for this server configuration description: a description of the configuration type. 'Storm 2GB', for example. disk: the amount of available disk space, in GB featured: some configurations are flagged as 'featured' so we show them on the Storm home page. This flag is devoid of any meaning otherwise. id: the id of this server configuration. Use this values as the 'config_id' in cloud/server/create and cloud/server/resize memory: the amount of available RAM, in MB price: a data structure giving the hourly price and estimated monthly price of this configuration zone_availability: a data structure giving the availability of this config for in various zones. vcpu: the number of CPUs available to this configuration
Parameters:
Parameter | Type | Notes |
---|---|---|
id | A positive integer value (i.e. 1 and up). | * Required |
Returns:
Field | Type | Notes |
---|---|---|
active | A boolean value (0 or 1). | |
available | A non-negative integer value (i.e. 0 and up). | |
category | A string. | |
cpu_cores | A positive integer value (i.e. 1 and up). | * Required if:
|
cpu_count | A positive integer value (i.e. 1 and up). | * Required if:
|
cpu_hyperthreading | A boolean value (0 or 1). | * Required if:
|
cpu_model | A string. | * Required if:
|
cpu_speed | A positive integer value (i.e. 1 and up). | * Required if:
|
description | A string. | |
disk | A positive integer value (i.e. 1 and up). | * Optional |
disk_count | A non-negative integer value (i.e. 0 and up). | * Required if:
|
disk_total | A non-negative integer value (i.e. 0 and up). | * Required if:
|
disk_type | A string permitting tabs, carriage returns and newlines | * Required if:
|
featured | A boolean value (0 or 1). | |
id | A positive integer value (i.e. 1 and up). | |
memory | A positive integer value (i.e. 1 and up). | * Optional |
raid_level | An integer value. | * Required if:
|
ram_available | A positive integer value (i.e. 1 and up). | * Required if:
|
ram_total | A positive integer value (i.e. 1 and up). | * Required if:
|
retired | A boolean value (0 or 1). | * Optional |
vcpu | A positive integer value (i.e. 1 and up). | * Optional |
zone_availability | An associative array of arbitrary keys and values. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
list
URL:
https://api.liquidweb.com/v1/Cloud/Config/list
Description:
Get a list of available server configurations. Only active configurations will be returned by this method, whereas the 'details' method will allow you to query information about an inactive configuration. For more information about the fields returned here, refer to the documentation for cloud/config/details.
valid options for category are storm, ssd, bare-metal and all.
Parameters:
Parameter | Type | Notes |
---|---|---|
available | A boolean value (0 or 1). | |
category | A single word, consisting of only letters, digits, hyphens, and underscores. | * Optional
|
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