Node monitor logs monitor-logs
Results of each probe round the control plane runs against monitored node IPs.
Pick an endpoint to see its example call on the right.
Authentication
Send the X-API-Key header (create a key on the API Keys page; the key is shown only once at creation). An Authorization: Bearer token obtained by logging in also works.
X-API-Key
Authentication failures return 401; forbidden returns 403 (code such as insufficient_scope).
Conventions
Paging uses page (from 1) and page_size; sort with sort=field or sort=-field.
Times are RFC 3339 (UTC); amounts are in cents.
Writes return 200/201/204 on success; duplicates of a unique key return 409.
/api/v2/monitor-logsList node monitor probe logs
Authentication: Admin only
Query parameters
| Field | Type | Description |
|---|---|---|
page | integer | Page number, starting from 1 |
page_size | integer | Items per page |
node_id | integer | Filter by node. |
ip | string | Filter by IP (exact match). |
result | integer | Filter by result: 1 reachable, 0 unreachable, -1 undetermined. |
type | string | Filter by type: aval availability probe, bw bandwidth sample. Omitted = all. |
since | string | Start time (inclusive), RFC 3339. |
until | string | End time (exclusive), RFC 3339. |
Node monitor logs object
| Field | Type | Description |
|---|---|---|
created_at | string | Created at |
detail | string | Why it was unreachable or undeterminable. |
id | integer | Record ID |
ip | string | Probed IP. |
node_id | integer | Node ID |
probers | MonitorLogProber[] | Node mutual probing results: the probers that probed this IP in this round and what each saw; with control-plane-only probing there is one entry (node_id 0 = control plane); empty for bandwidth sample rows. |
result | integer | 1: reachable; 0: unreachable; -1: undeterminable (http 5xx, whole round unreachable, etc.; not counted). |
round_id | integer | Probe round (same value within one round). |
type | string | aval: availability probe; bw: bandwidth sample (one per minute, 0 when outbound is at or above the limit). |
Responses and errors
Success returns the resource JSON directly (HTTP 2xx); failures return application/problem+json (code, detail, plus errors on validation failures); lists carry items + total.
{
"id": 1,
"name": "example"
}{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}{
"code": "validation_failed",
"detail": "Invalid request parameters",
"errors": [
{
"code": "required",
"field": "/name",
"message": "name is required"
}
],
"request_id": "0123456789abcdef",
"status": 422,
"title": "Unprocessable Entity",
"type": "about:blank"
}