URL:
https://api.liquidweb.com/v1/Monitoring/Bandwidth/graph
Description:
Get a bandwidth usage graph for a server. The image is returned as a base64
encoded blob.
'frequency' is the duration of the graph you wish to see. For example, if frequency
is daily, the bandwidth usage for the last day would be graphed. The default is to
get the last month, but the following options are available:
'daily', 'weekly', 'monthly', 'yearly'
Examples:
Perl:
my $graph = $api->request('monitoring/bandwidth/graph', { uniq_id => ABC123 });
print "Content-type: $graph->{content_type}\n\n";
print MIME::Base64::decode_base64($graph->{content});
Parameters:
| Parameter | Type | Notes |
|---|
| frequency | A single word, consisting of only letters and digits. | |
| height | A positive integer value (i.e. 1 and up). | |
| small | A boolean value (0 or 1). | |
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
| width | A positive integer value (i.e. 1 and up). | |
Returns:
| Field | Type |
|---|
| content | A base64 string, consisting of letters, digits, +, /, possibly terminated by zero to two "=" characters |
| content_type | A MIME type, such as application/octet-stream, image/png, or text/plain |
Possible Errors:
Refer to the Error Handling documentation for the
list of exception types
URL:
https://api.liquidweb.com/v1/Monitoring/Bandwidth/stats
Description:
Get bandwidth usage stats for a server.
Parameters:
| Parameter | Type | Notes |
|---|
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type |
|---|
| actual | An associative array containing the fields: |
| | | both | An associative array containing the fields: |
| | | B | A floating-point value. | | GB | A floating-point value. | | KB | A floating-point value. | | MB | A floating-point value. |
|
| in | An associative array containing the fields: |
| | | B | A floating-point value. | | GB | A floating-point value. | | KB | A floating-point value. | | MB | A floating-point value. |
|
| out | An associative array containing the fields: |
| | | B | A floating-point value. | | GB | A floating-point value. | | KB | A floating-point value. | | MB | A floating-point value. |
|
|
| averages | An associative array containing the fields: |
| | | day | An associative array containing the fields: |
| | | both | An associative array containing the fields: |
| | | B | A floating-point value. | | GB | A floating-point value. | | KB | A floating-point value. | | MB | A floating-point value. |
|
| in | An associative array containing the fields: |
| | | B | A floating-point value. | | GB | A floating-point value. | | KB | A floating-point value. | | MB | A floating-point value. |
|
| out | An associative array containing the fields: |
| | | B | A floating-point value. | | GB | A floating-point value. | | KB | A floating-point value. | | MB | A floating-point value. |
|
|
| hour | An associative array containing the fields: |
| | | both | An associative array containing the fields: |
| | | B | A floating-point value. | | GB | A floating-point value. | | KB | A floating-point value. | | MB | A floating-point value. |
|
| in | An associative array containing the fields: |
| | | B | A floating-point value. | | GB | A floating-point value. | | KB | A floating-point value. | | MB | A floating-point value. |
|
| out | An associative array containing the fields: |
| | | B | A floating-point value. | | GB | A floating-point value. | | KB | A floating-point value. | | MB | A floating-point value. |
|
|
| minute | An associative array containing the fields: |
| | | both | An associative array containing the fields: |
| | | B | A floating-point value. | | GB | A floating-point value. | | KB | A floating-point value. | | MB | A floating-point value. |
|
| in | An associative array containing the fields: |
| | | B | A floating-point value. | | GB | A floating-point value. | | KB | A floating-point value. | | MB | A floating-point value. |
|
| out | An associative array containing the fields: |
| | | B | A floating-point value. | | GB | A floating-point value. | | KB | A floating-point value. | | MB | A floating-point value. |
|
|
| month | An associative array containing the fields: |
| | | both | An associative array containing the fields: |
| | | B | A floating-point value. | | GB | A floating-point value. | | KB | A floating-point value. | | MB | A floating-point value. |
|
| in | An associative array containing the fields: |
| | | B | A floating-point value. | | GB | A floating-point value. | | KB | A floating-point value. | | MB | A floating-point value. |
|
| out | An associative array containing the fields: |
| | | B | A floating-point value. | | GB | A floating-point value. | | KB | A floating-point value. | | MB | A floating-point value. |
|
|
| second | An associative array containing the fields: |
| | | both | An associative array containing the fields: |
| | | B | A floating-point value. | | GB | A floating-point value. | | KB | A floating-point value. | | MB | A floating-point value. |
|
| in | An associative array containing the fields: |
| | | B | A floating-point value. | | GB | A floating-point value. | | KB | A floating-point value. | | MB | A floating-point value. |
|
| out | An associative array containing the fields: |
| | | B | A floating-point value. | | GB | A floating-point value. | | KB | A floating-point value. | | MB | A floating-point value. |
|
|
| week | An associative array containing the fields: |
| | | both | An associative array containing the fields: |
| | | B | A floating-point value. | | GB | A floating-point value. | | KB | A floating-point value. | | MB | A floating-point value. |
|
| in | An associative array containing the fields: |
| | | B | A floating-point value. | | GB | A floating-point value. | | KB | A floating-point value. | | MB | A floating-point value. |
|
| out | An associative array containing the fields: |
| | | B | A floating-point value. | | GB | A floating-point value. | | KB | A floating-point value. | | MB | A floating-point value. |
|
|
| year | An associative array containing the fields: |
| | | both | An associative array containing the fields: |
| | | B | A floating-point value. | | GB | A floating-point value. | | KB | A floating-point value. | | MB | A floating-point value. |
|
| in | An associative array containing the fields: |
| | | B | A floating-point value. | | GB | A floating-point value. | | KB | A floating-point value. | | MB | A floating-point value. |
|
| out | An associative array containing the fields: |
| | | B | A floating-point value. | | GB | A floating-point value. | | KB | A floating-point value. | | MB | A floating-point value. |
|
|
|
| cost | An associative array containing the fields: |
| | | current | A monetary value, such as -$.05, 0.05, or -5.00 | | projected | A monetary value, such as -$.05, 0.05, or -5.00 |
|
| domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) |
| pricing | An associative array containing the fields: |
| | | per_gb_over | A monetary value, such as -$.05, 0.05, or -5.00 | | price | A monetary value, such as -$.05, 0.05, or -5.00 | | quota | A non-negative integer value (i.e. 0 and up). |
|
| projected | An associative array containing the fields: |
| | | both | An associative array containing the fields: |
| | | B | A floating-point value. | | GB | A floating-point value. | | KB | A floating-point value. | | MB | A floating-point value. |
|
| in | An associative array containing the fields: |
| | | B | A floating-point value. | | GB | A floating-point value. | | KB | A floating-point value. | | MB | A floating-point value. |
|
| out | An associative array containing the fields: |
| | | B | A floating-point value. | | GB | A floating-point value. | | KB | A floating-point value. | | MB | A floating-point value. |
|
|
Possible Errors:
Refer to the Error Handling documentation for the
list of exception types
