Version 2.4.8 · latest

Package monitor package-monitor

Admin only: bandwidth and connections of each purchased package over the last minute.

Pick an endpoint to see its example call on the right.

PackagesAuthentication: Admin only2 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/package-monitorPackage monitor

Authentication: Admin only

Query parameters

FieldTypeDescription
pageinteger Page number, starting from 1
Default 1
page_sizeinteger Items per page
Default 20
sortstring Sort fields, comma-separated; prefix `-` for descending, e.g. `-created_at,id`
tenant_idinteger Admin only: filter by tenant (a malformed value returns 422). Ignored for tenant credentials, which only see their own tenant's data
tenant_idsstring Admin only: only these tenants, comma-separated positive integers, at most 200 after deduplication (more, or a malformed value, returns 422); a single ID works too. Filters only and does not switch the request scope; combined with tenant_id and other filters as an intersection. A tenant credential sending a non-empty value gets 403
user_package_idinteger Filter by user package id.
node_idinteger Node ID
upidsstring Only these user packages: comma-separated positive integers, at most 200 after deduplication (more, or a malformed value, returns 422); combined with user_package_id as an intersection.
node_idsstring Only these nodes: comma-separated positive integers, at most 200 after deduplication (more, or a malformed value, returns 422); combined with node_id as an intersection.

Package monitor object

FieldTypeDescription
bandwidth_bpsinteger Sum of outbound bandwidth across nodes over the last minute (bit/s).
bandwidth_limit_mbpsinteger Effective bandwidth quota (including add-ons); -1 means unlimited.
connectionsinteger Sum of per-node peak connection counts over the last minute.
connections_limitinteger Effective connection quota (including add-ons); -1 means unlimited.
itemsPackageMonitorNode[] Items on this page
namestring Name
tenant_idinteger Owner tenant (user) ID
user_package_idinteger Purchased package ID.

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