Server Bandwidth

Revision as of 23:42, 5 April 2012

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.

Path

• /server/bandwidth/{$serverid}/{$start}/{$end}

Method

• GET

Availability

• Dedicated Server
• Dynamic Server
• Private Cloud
• Public Cloud

Required Data Parameters

• {$serverid}: The server ID that is returned when using the list command.
• {$start}: The start date and time of the bandwidth records to be retrieved (unix timestamp).
• {$end}: The end date and time of the bandwidth records to be retrieved (unix timestamp).

Optional Data Parameters

• None

Returned Data

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(
      [0] => stdClass Object(
        [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).
      )
    )
  )
)