Metrics

Download schema

Endpoints for the host metrics agents send every minute: CPU, load, memory, swap, file systems, disk I/O, network, TCP and processes.

Get a server's current metrics

GET

https://server.chief.app/api/v1

/servers/{server}/metrics

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Get the newest value of every metric the server sent in the last 10 minutes. File system metrics are per mount point; disk and network metrics per disk and interface, plus the host total without an instance.

Get a server's current metrics › path Parameters

server

string · required

Get a server's current metrics › Responses

ServerMetrics

ServerMetrics · required

Get a server's metric series

GET

https://server.chief.app/api/v1

/servers/{server}/metrics/series

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Get the average, lowest and highest value per bucket of up to 10 metrics over a range ending now, such as for charts or to see how a value developed. Samples are kept per minute for 8 days, per 5 minutes for 90 days and per hour for 2 years, as far back as the metrics history of the team's plan.

Get a server's metric series › path Parameters

server

string · required

Get a server's metric series › query Parameters

range

string | null · enum

The period to return, ending now. Points are averages per bucket: 1 minute up to 6h, 5 minutes for 24h, 30 minutes for 7d, 2 hours for 30d and a day for 1y.

Enum values:

24h

30d

Default: 6h

metrics[]

string[] · minItems: 1 · maxItems: 10

Enum values:

cpu.user

cpu.system

cpu.iowait

cpu.steal

cpu.idle

cpu.cores

load.1

load.5

instance

string | null · maxLength: 128

Only return this mount point, disk or interface. Without it, every instance is returned; host totals of disks and interfaces have an empty instance.

Get a server's metric series › Responses

ServerMetricSeries

ServerMetricSeries · required

Vulnerabilities Alerts