Skip to main content
Use this endpoint to poll the live runtime metrics of a single application. The response tells you whether the application is currently running, how much CPU and RAM it is consuming, its network throughput at this moment versus total usage, its on-disk storage footprint, and how long it has been up. Integrate these metrics into your own monitoring dashboards or use them to trigger automated scaling decisions.

​
Endpoint

GET https://api.virtuscloud.app/v2/apps/{app_id}/status

​
Path parameters

​
app_id
string
required
The unique ID of the application. You can find this in the URL of your application’s dashboard page on Virtus Cloud.

​
Request headers

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

​
Response

​
status
string
Indicates whether the request succeeded. Returns "success" on a successful call.
​
response
object
The real-time runtime metrics for the application.

​
Code example

curl --request GET \
  --url https://api.virtuscloud.app/v2/apps/<app_id>/status \
  --header "Authorization: <your_api_key>"

​
Response example

{
  "status": "success",
  "response": {
    "cpu": "0.01%",
    "ram": "31.79",
    "status": "running",
    "running": true,
    "storage": "2.72MB",
    "network": {
      "total": "602 KB ↑ 134 KB ↓",
      "now": "14 KB ↑ 3.3 KB ↓"
    },
    "uptime": 1662927833666
  }
}