Fetch Server Telemetry

Fetches a collection of timestamped data points for a specific server's load, RAM, and storage usage.

Requires the servers-view permission.

query
  • sort

    Sorts can be performed on any field - see sorting

  • filter

    Collections of resources can be filtered based on certain criteria - see filtering  Accepted filters: range

If filtering by range, you have a few available options. Set it to hour to get data points grouped by the minute. Set it to day to get hourly data points. Set it to week to get daily data points. Set it tomonth to get a collection of data points grouped by day. Finally, set it to year to get a collection of data points grouped by months.

Returns

Returns an array of telemetry data points, otherwise returns an Error.

Telemetry Data Point
  • time
    timestamp

    The time the data point was sampled.

  • load
    object

    Stats relating to the load of the server.

    Show child fields
  • ram
    object

    Information about the RAM on this server.

    Show child fields
  • storage_base
    object

    Information about the root storage of this server.

    Show child fields
  • storage_pool
    object

    User data storage across all devices.

    Show child fields

GET /v1/infrastructure/servers/{ID}/telemetry

Example Request
$ curl https://api.cycle.io/v1/infrastructure/servers/5dd333ee4146380001d9e3b5/telemetry?filter[range]=day \
-H
"Authorization: Bearer API_KEY"
\
-H
"X-Hub-Id: HUB_ID"
Example Response
[
{
"time": "2019-06-15T20:45:00Z",
"load": {
"avg1m": 0.43,
"avg5m": 0.27,
"avg15m": 0.22
},
"ram": {
"free": 4679120,
"available": 6944156,
"total": 8142668
},
"storage_base": {
"free": 46521696,
"available": 0,
"total": 50133544
}
},
{
"time": "2019-06-15T21:00:00Z",
"load": {
"avg1m": 0.17,
"avg5m": 0.25,
"avg15m": 0.23
},
"ram": {
"free": 4686624,
"available": 6951672,
"total": 8142668
},
"storage_base": {
"free": 46521692,
"available": 0,
"total": 50133544
}
},
{
"time": "2019-06-15T21:15:00Z",
"load": {
"avg1m": 0.22,
"avg5m": 0.24,
"avg15m": 0.25
},
"ram": {
"free": 4680088,
"available": 6945240,
"total": 8142668
},
"storage_base": {
"free": 46521624,
"available": 0,
"total": 50133544
},
"storage_pool": {
"data_percent": 10,
"meta_percent": 15,
"total": 65
}
}
]