(Created page with "The server bandwidth command ==Path== */server/bandwidth/{$serverid}/{$start}/{$end} ==Method== *GET ==Availability== *[[servers#Dedicated Serve...") |
|||
| Line 1: | Line 1: | ||
| − | The [[Server|server]] bandwidth command | + | The [[Server|server]] bandwidth command will return a list the bandwidth usage for a server for a specified period. When this command is run it may take a few minutes for it to finish. |
==Path== | ==Path== | ||
*/server/bandwidth/{$serverid}/{$start}/{$end} | */server/bandwidth/{$serverid}/{$start}/{$end} | ||
| Line 14: | Line 14: | ||
==Required Data Parameters== | ==Required Data Parameters== | ||
*{$serverid}: The server ID that is returned when using the [[Server List|list]] command. | *{$serverid}: The server ID that is returned when using the [[Server List|list]] command. | ||
| − | *{$start}: . | + | *{$start}: The start date and time of the bandwidth records to be retrieved (unix timestamp). |
| − | *{$end}: . | + | *{$end}: The end date and time of the bandwidth records to be retrieved (unix timestamp). |
==Optional Data Parameters== | ==Optional Data Parameters== | ||
| Line 25: | Line 25: | ||
[success] => TRUE/FALSE | [success] => TRUE/FALSE | ||
[data] => stdClass Object( | [data] => stdClass Object( | ||
| − | + | [intotal] => The total inbound bandwidth used for the specified start/end time. | |
| + | [outtotal] => The total outbound bandwidth used for the specified start/end time. | ||
| + | [dailyusage] => array( | ||
| + | [in] => Inbound bandwidth used on a specific date. | ||
| + | [out] => Outbound bandwidth used on a specific date. | ||
| + | [timestamp] => The date the bandwidth usage was retrieved (unix timestamp). | ||
| + | [date] => The date the bandwidth usage was retrieved (human readable). | ||
| + | ) | ||
) | ) | ||
) | ) | ||
</pre> | </pre> | ||
The server bandwidth command will return a list the bandwidth usage for a server for a specified period. When this command is run it may take a few minutes for it to finish.
Contents |
stdClass Object(
[success] => TRUE/FALSE
[data] => stdClass Object(
[intotal] => The total inbound bandwidth used for the specified start/end time.
[outtotal] => The total outbound bandwidth used for the specified start/end time.
[dailyusage] => array(
[in] => Inbound bandwidth used on a specific date.
[out] => Outbound bandwidth used on a specific date.
[timestamp] => The date the bandwidth usage was retrieved (unix timestamp).
[date] => The date the bandwidth usage was retrieved (human readable).
)
)
)