Get server traffic usage
GET
Returns the VPS's used and remaining monthly traffic allowance.
Access: API key: vm:read · Session: any workspace role.
- Amounts are in bytes. Unmetered plans have
metered: falseand zero byte fields. overflow_bytesshows usage beyond the allowance.network_suspendedindicates suspension for an overdue account.- Values refresh about once a minute. Creation/deletion returns
409; temporarily unavailable readings return503.
header
AuthorizationBearer <token>Send Authorization: Bearer <token>. A token is an API key (lb_live_…, scoped, for programs) or a session (lb_sess_…, from signup or login, for people). See Authentication above.
id*stringThe resource id.
X-Org-ID?stringSessions only: act on this organization (you must be a member). Default: your first organization.
Traffic usage
application/json- response
metered*booleanfalse when the plan has no traffic cap.
used_bytes*integerFormat
int64total_bytes*integerFormat
int64remaining_bytes*integerFormat
int64overflow_bytes*integerTraffic beyond the allowance in this period.
Format
int64period_start*|Format
date-timeperiod_end*|When the allowance resets.
Format
date-timenetwork_suspended*booleanThe network was cut because the account is overdue.
curl -X GET 'https://layerbeat.com/v1/vms/string/traffic'{ "metered": true, "used_bytes": 53687091200, "total_bytes": 1073741824000, "remaining_bytes": 1020054732800, "overflow_bytes": 0, "period_start": "2026-10-01T00:00:00Z", "period_end": "2026-11-01T00:00:00Z", "network_suspended": false}