Package monitor
Admin only: bandwidth and connections of each purchased package over the last minute.
package-monitorPackagesAuthentication: Admin only2 endpointsPackage monitor
GET
/api/v2/package-monitorAuthentication: Admin only
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| page | integer | — | Page number, starting from 1 |
| page_size | integer | — | Items per page |
| sort | string | — | Sort fields, comma-separated; prefix `-` for descending, e.g. `-created_at,id` |
| tenant_id | integer | — | Admin only: filter by tenant. Ignored for tenant credentials, which only see their own tenant's data |
| user_package_id | integer | — | Filter by user package id. |
| node_id | integer | — | Node ID |
Package monitor by node
GET
/api/v2/package-monitor/{id}/nodesAuthentication: Admin only
Package monitor object
| Field | Type | Required | Description |
|---|---|---|---|
| bandwidth_bps | integer | — | Sum of outbound bandwidth across nodes over the last minute (bit/s). |
| bandwidth_limit_mbps | integer | — | Effective bandwidth quota (including upgrade packs); -1 means unlimited. |
| connections | integer | — | Sum of per-node peak connection counts over the last minute. |
| connections_limit | integer | — | Effective connection quota (including upgrade packs); -1 means unlimited. |
| items | PackageMonitorNode[] | — | Items on this page |
| name | string | — | Name |
| tenant_id | integer | — | Owner tenant (user) ID |
| user_package_id | integer | — | Purchased package ID. |