Version 2.4.8 · latest

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.

Node schedulingAuthentication: Admin only1 endpoints

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.

GET/api/v2/monitor-logsList node monitor probe logs

Authentication: Admin only

Query parameters

FieldTypeDescription
pageinteger Page number, starting from 1
Default 1
page_sizeinteger Items per page
Default 20
node_idinteger Filter by node.
ipstring Filter by IP (exact match).
resultinteger Filter by result: 1 reachable, 0 unreachable, -1 undetermined.
Values [-1,0,1]
typestring Filter by type: aval availability probe, bw bandwidth sample. Omitted = all.
Values ["aval","bw"]
sincestring Start time (inclusive), RFC 3339.
untilstring End time (exclusive), RFC 3339.

Node monitor logs object

FieldTypeDescription
created_atstring Created at
detailstring Why it was unreachable or undeterminable.
idinteger Record ID
ipstring Probed IP.
node_idinteger Node ID
probersMonitorLogProber[] 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.
resultinteger 1: reachable; 0: unreachable; -1: undeterminable (http 5xx, whole round unreachable, etc.; not counted).
Values [-1,0,1]
round_idinteger Probe round (same value within one round).
typestring aval: availability probe; bw: bandwidth sample (one per minute, 0 when outbound is at or above the limit).
Values ["aval","bw"]

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.

Success
{
  "id": 1,
  "name": "example"
}
List
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
Error
{
  "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"
}
Get started

Try the live demo

Open the live demo, or contact us for a quote and the install command