Logo
OpenScaler

VM dashboard summary

GET
/v1/vms-dashboard-info

Aggregated VM counts and status for the dashboard.

Authorization

bearer_auth
AuthorizationBearer <token>

Authentication

Create an API token on Profile. 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

Query Parameters

project_id*string

ID of the project used to filter results.

Response Body

application/json

application/json

text/pain

application/json

application/json

curl -X GET "https://example.com/v1/vms-dashboard-info?project_id=default"
{  "vms": 12,  "k8s_nodes": 3,  "regions": 2,  "projects": 1,  "running_vms": 8,  "stopped_vms": 4}
{  "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"    }  ]}