API DocumentationStats
Retrieve Load Balancer Stats
Get traffic and performance statistics for a load balancer.
Use timespan to get recent stats over a rolling window, or provide start/end
(Unix timestamps in milliseconds) for a custom range.
Authorization
bearer_auth AuthorizationBearer <token>
Authentication
Create an API token on Profile, or with osctl auth login. Send it in the Authorization header:
Authorization: Bearer os1_...Do not use the Keycloak web-session JWT as an API token. Keep the secret secure and do not share it.
In: header
Path Parameters
lb_id*string
A unique identifier for a load balancer instance.
Format
uuidQuery Parameters
timespan?integer
time range to get stats from (in seconds):
- 10 minutes
- 1 hour
- 1 day
- 1 week
- 1 month (31 days)
- 1 year (366 days) if omitted, will send live stats (use this for testing only, not for production)
Value in
- 600
- 3600
- 86400
- 604800
- 2678400
- 31622400
start?integer
unix timestamp of the first datapoint
end?integer
unix timestamp of the last datapoint
Response Body
application/json
application/json
text/pain
application/json
application/json
curl -X GET "https://example.com/v1/lbs/550e8400-e29b-41d4-a716-446655440000/stats"{ "meta": { "step": 60, "start": 1672565200, "end": 1672565200, "rows": 120, "columns": 10 }, "data": [ [] ]}{ "errors": [ { "message": "'vcpus' field must be an integer", "field": "resource_id" } ]}"Access denied"{ "errors": [ { "message": "User not initialized. Send POST /v1/init, then retry the request." } ]}{ "errors": [ { "message": "VM with ID 23 not found" } ]}