Error Handling
Methods
- Account/
- Account/Auth/
- Account/Auth/TwoFactor/
- Account/BillingAddress/
- Account/ChangeOrder/Source/
- Account/ChatPassword/
- Account/Contact/
- Account/CreditCard/
- Account/Cycle/
- Account/Limits/
- Account/PasswordReset/
- Account/Paymethod/
- Account/SSH/Key/
- Account/Settings/
- Account/Subscriptions/
- Account/User/
- Account/User/StateData/
- Acronis/Backup/
- Asset/
- Asset/Connections/
- Asset/ControlPanel/Credentials/
- Asset/Measurements/
- Asset/Monitoring/
- Attribution/
- Basket/
- Basket/Domain/
- Basket/Item/
- Basket/Item/Config/
- Billing/
- Billing/Bill/
- Billing/Credit/
- Billing/CreditCard/Profile/
- Billing/Cycle/
- Billing/Invoice/
- Billing/Invoice/Preview/
- Billing/PayPal/Agreement/
- Billing/PayPal/Payment/
- Billing/Payment/
- Billing/Payment/Profile/
- BusinessEmail/Customer/
- BusinessEmail/Domain/
- Cloud/Backup/
- Cloud/Config/
- Cloud/IP/Pool/
- Cloud/Image/
- Cloud/Private/Parent/
- Cloud/Server/
- Cloud/Template/
- CloudSites/
- CloudSites/Usage/
- CodeGuard/User/
- Contact/
- Coupon/
- Coupon/Claim/
- Domain/
- Domain/Services/
- HostedEmail/Customer/
- HostedEmail/Domain/
- Licensing/
- Licensing/Cpanel/
- Licensing/Plesk/
- Market/Bundle/
- Market/Bundle/Package/
- Market/Cart/
- Market/Cart/Admin/Quote/
- Market/Cart/Discount/
- Market/Cart/Helpers/Configurator/
- Market/Cart/Item/
- Market/Package/
- Market/Package/Product/
- Market/Place/
- Meta/Timing/
- Migration/
- Migration/Account/
- Migration/Account/Server/
- Migration/Account/Server/Access/
- Migration/Destination/
- Monitoring/Bandwidth/
- Monitoring/Load/
- Monitoring/MWP/
- Monitoring/Services/
- Network/CDN/User/
- Network/CDN/Zone/
- Network/DNS/Domain/
- Network/DNS/Domain/Contact/
- Network/DNS/Domain/Nameserver/
- Network/DNS/Domain/Transfer/
- Network/DNS/Record/
- Network/DNS/Reverse/
- Network/DNS/Zone/
- Network/DNS/Zone/History/
- Network/Firewall/
- Network/Firewall/Ruleset/
- Network/IP/
- Network/LoadBalancer/
- Network/Pool/
- Network/Private/
- Network/SSHKey/
- Network/Util/
- Network/Zone/
- Notifications/
- OneTimeSecret/
- Order/AddOn/
- Product/
- Product/Addon/
- Product/Marketplace/
- Product/Series/
- Project/
- SSL/Certificate/
- Salesforce/Account/InterWorx/
- Salesforce/Chat/Auth/
- Salesforce/User/
- Server/
- Server/Auth/
- Server/Power/
- Server/VirtualDomain/
- Server/WHM/AccessHash/
- Server/WHM/DNS/
- Server/WHM/Firewall/
- Signup/Basic/
- Storage/Block/Cluster/
- Storage/Block/Volume/
- Storage/ObjectStore/
- Support/Alert/
- Support/Request/
- Support/Request/Attachment/
- Support/SystemStatus/
- Support/Ticket/Auth/
- Tags/Product/
- UserTask/
- Utilities/Info/
- VIP/
- VMware/vCloud/vDC/
- VPN/
- VPN/User/
- WWW/Cart/
- WordPress/Domain/
API Documentation (API Version bleed)
Cloud/Backup/
DESCRIPTION
For customers with a backup plan, their servers are backed up daily. This section of the api allows remote interaction with those backups.
details
URL:
https://api.liquidweb.com/bleed/Cloud/Backup/details
Description:
Get information about a specific backup.
Here's a rundown of what the returned fields mean:
accnt: your account number id: the id of the backup features: an associate array of feature data that will be applied to any server created from this backup name: a displayable backup name size: the size of the backup, in GB template: the name of the OS template image from which this backup was created time_taken: the date and time at which the backup was created uniq_id: the unique server identifier, made of 6 letters and numbers, of the server from which this backup was created
Parameters:
Parameter | Type | Notes |
---|---|---|
id | A positive integer value (i.e. 1 and up). | * Required |
uniq_id | A six-character identifier, containing only capital letters and digits. |
Returns:
Field | Type | Notes |
---|---|---|
accnt | A valid account number, up to 6 digits in length. | |
features | An associative array of arbitrary keys and values. | * Optional |
hv_type | A single word, consisting of only letters and digits. | |
id | A positive integer value (i.e. 1 and up). | |
name | A string. | |
size | A positive floating-point value requiring a leading whole number. | |
template | A string. | |
time_taken | A valid date and time in YYYY-MM-DD HH:MM:SS format. | |
uniq_id | A six-character identifier, containing only capital letters and digits. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
list
URL:
https://api.liquidweb.com/bleed/Cloud/Backup/list
Description:
Get a paginated list of backups for a particular server. More information about the data returned can be found under the documentation for cloud/backup/details
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
|
uniq_id | A six-character identifier, containing only capital letters and digits. |
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
restore
URL:
https://api.liquidweb.com/bleed/Cloud/Backup/restore
Description:
Re-images a server with the backup image requested. If the 'force' flag is passed it will rebuild the filesystem on the server before restoring. This option is not usually needed, but if regular restores are failing, it can fix some scenarios.
Parameters:
Parameter | Type | Notes |
---|---|---|
force | A boolean value (0 or 1). | |
id | A positive integer value (i.e. 1 and up). | * Required |
uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
Field | Type |
---|---|
restored | A six-character identifier, containing only capital letters and digits. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types