Skip to main content
GET
Get all usage graphs

Authorizations

Authorization
string
header
required

Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.

Path Parameters

server
string
required

The server UUID

Example:

"ecc6f4f1"

Query Parameters

period
enum<string> | null

The value of period.

Available options:
hour,
day,
week,
month,
year
Example:

"day"

aggregation
enum<string> | null

The value of aggregation.

Available options:
average,
maximum
Example:

"maximum"

Response

The record, as a JSON object. There is no envelope.

A server's resource history over one window: what was asked for, and what came back.

period
enum<string>
required

The window the series cover, counted back from now.

Available options:
hour,
day,
week,
month,
year
Example:

"hour"

aggregation
enum<string>
required

How the samples inside each bucket of the series were consolidated.

Available options:
average,
maximum
Example:

"average"

unavailable
string | null
required

Null when the series below were read, and a sentence saying so when they could not be.

Example:

null

series
ServerMetricSeriesData · object
required

The value of series.

Example: