hello,
Home Page
Overview
Error Handling
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/Region/
- 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)
Utilities/Info/
DESCRIPTION
This section contains some basic methods for getting the version and state of the api.
ping
URL:
https://api.liquidweb.com/v1/Utilities/Info/ping
Description:
This method can be used as a basic check to see if communication with the api is possible.
Parameters:
No Values Defined
Returns:
| Field | Type |
|---|---|
| ping | A single word, consisting of only letters and digits. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
version
URL:
https://api.liquidweb.com/v1/Utilities/Info/version
Description:
Returns the version of the of the api your are using.
Parameters:
No Values Defined
Returns:
| Field | Type |
|---|---|
| version | A string of text, containing no newlines or other control characters. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
