Status

The runner's and the agents' status, series and alerts.

The runner's last status snapshot

GET /v1/installations/{i}/status

Parameters

Name	In	Type	Description
i (required)	path	string

Responses

Status	Description	Body
200	runner is the snapshot as the runner sent it (null before the first), at when it came.	object
401	Unauthorized: No valid API key (or session). login_url is for the panel.	Error
429	TooMany: rate_limited: over the key's or the address's rate (see Rate limits); wait Retry-After seconds.	Error
404	NotFound: No such object in your account (another account's ids answer the same).	Error

The agents of the organizations at customers

GET /v1/installations/{i}/agents

Parameters

Name	In	Type	Description
i (required)	path	string

Responses

Status	Description	Body
200	One row per agent.	object
401	Unauthorized: No valid API key (or session). login_url is for the panel.	Error
429	TooMany: rate_limited: over the key's or the address's rate (see Rate limits); wait Retry-After seconds.	Error
404	NotFound: No such object in your account (another account's ids answer the same).	Error

Time series of the organizations at customers

GET /v1/installations/{i}/series

Parameters

Name	In	Type	Description
i (required)	path	string
metric (required)	query	string	Up to 20, comma separated: agent_connected, probe_ok, rtt_ms, db_bytes, streams, relay_sessions, queries, errors, fdw, direct, p50_ms, p95_ms.
org	query	string
from (required)	query	string (date-time)
to (required)	query	string (date-time)
step	query	string: 1m, 1h

Responses

Status	Description	Body
200	The series; points are [time, value].	object
400	BadRequest: A field is missing or wrong.	Error
401	Unauthorized: No valid API key (or session). login_url is for the panel.	Error
429	TooMany: rate_limited: over the key's or the address's rate (see Rate limits); wait Retry-After seconds.	Error
404	NotFound: No such object in your account (another account's ids answer the same).	Error

Availability and errors over a period

GET /v1/installations/{i}/series/summary

Parameters

Name	In	Type	Description
i (required)	path	string
from (required)	query	string (date-time)
to (required)	query	string (date-time)

Responses

Status	Description	Body
200	The summary.	object
400	BadRequest: A field is missing or wrong.	Error
401	Unauthorized: No valid API key (or session). login_url is for the panel.	Error
429	TooMany: rate_limited: over the key's or the address's rate (see Rate limits); wait Retry-After seconds.	Error
404	NotFound: No such object in your account (another account's ids answer the same).	Error

Alert rules and recent alerts

GET /v1/accounts/{a}/alerts

Parameters

Name	In	Type	Description
a (required)	path	string	Your account's id (the panel's URL, or account in a move).

Responses

Status	Description	Body
200	The rules and the alerts.	object
401	Unauthorized: No valid API key (or session). login_url is for the panel.	Error
429	TooMany: rate_limited: over the key's or the address's rate (see Rate limits); wait Retry-After seconds.	Error
404	NotFound: No such object in your account (another account's ids answer the same).	Error

Set the alert rules

PUT /v1/accounts/{a}/alerts

Parameters

Name	In	Type	Description
a (required)	path	string	Your account's id (the panel's URL, or account in a move).

Body (application/json)

Field	Type	Description
rules (required)	array of AlertRule

Responses

Status	Description	Body
200	The rules as saved.	object
400	BadRequest: A field is missing or wrong.	Error
401	Unauthorized: No valid API key (or session). login_url is for the panel.	Error
429	TooMany: rate_limited: over the key's or the address's rate (see Rate limits); wait Retry-After seconds.	Error
403	Forbidden: The account is pending (account_pending, activated by us after "request access"), suspended, or the route is the owner's, or the key is read-only.	Error
404	NotFound: No such object in your account (another account's ids answer the same).	Error