Skip to main content
Use this endpoint to fetch the live runtime status of every application associated with your account or a specific workspace in a single call. Each item in the response array gives you the application ID, current CPU usage, RAM consumption, and whether the application is running. This endpoint is rate-limited to 15 requests per 60 seconds — design your polling strategy accordingly.
If you omit the workspaceId query parameter, the API returns status information for all applications under your personal account. To scope the response to a specific workspace, provide its ID.

Endpoint

GET https://api.virtuscloud.app/v2/apps/status

Request headers

Authorization
string
required
Your Virtus Cloud API key. See Authentication for details.

Query parameters

workspaceId
string
The ID of the workspace whose applications you want to query. You can find the workspace ID beneath your workspace name in the Virtus Cloud dashboard. If omitted, the endpoint returns statuses for all applications in your personal account.

Response

status
string
Indicates whether the request succeeded. Returns "success" on a successful call.
response
array
An array of runtime status objects, one per application.

Code example

# All applications in your account
curl --request GET \
  --url https://api.virtuscloud.app/v2/apps/status \
  --header "Authorization: <your_api_key>"

# Scoped to a specific workspace
curl --request GET \
  --url "https://api.virtuscloud.app/v2/apps/status?workspaceId=<workspace_id>" \
  --header "Authorization: <your_api_key>"

Response example

{
  "status": "success",
  "response": [
    {
      "id": "5bbd020126ee4692aga43e0ca0a75454",
      "cpu": "0.00%",
      "ram": "55.88MB",
      "running": true
    },
    {
      "id": "e1b286ba30f14a87baed4b4ad3b53c47",
      "cpu": "0.01%",
      "ram": "68.44MB",
      "running": true
    }
  ]
}