Retrieve aggregate live public network stats

Get live public network traffic stats for all resources (Useful for dashboard traffic in/out, ⚠️ prefer this endpoint to /stats/live when updating traffic stats frequently).

Authorization

AuthorizationRequiredBearer <token>

OAuth Authentication

OpenScaler API uses OAuth, a standard for secure authorization. To access the API, obtain a token via the OpenScaler Platform.

Use the access_token in the Authorization header for requests:

Authorization: Bearer <token>

Always keep your token secure and do not share it with anyone.

In: header

Query Parameters

include_vpcsboolean

If true, response will also include list of all VPC stats that were used to obtain the total.

Default: false

curl -X GET "https://api.alpha.openscaler.net/v1/stats/network/live" \
  -H "Authorization: Bearer <token>"

Returns live public network traffic stats for all resources.

{
  "timestamp": 1715514230,
  "step": 5,
  "data": {
    "network.rx": 728338.8,
    "network.tx": 1547975,
    "vpcs": [
      {
        "vpc_id": 1,
        "network.rx": 728338.8,
        "network.tx": 1547975
      }
    ]
  }
}

Retrieve aggregate live public network stats

Authorization

OAuth Authentication

Query Parameters

Response

TypeScript