Skip to main content
Use this endpoint to inspect the current operational state of a specific database. The response tells you whether the database is running, how much CPU and RAM it is consuming, current storage use, live network throughput, and the timestamp of when it started.

Request

GET https://api.virtuscloud.app/v2/databases/{databaseId}/status

Headers

Authorization
string
required
Your Virtus Cloud API key. Pass it directly as the header value — no prefix required.Example: Authorization: vc_live_xxxxxxxxxxxx

Path Parameters

databaseId
string
required
The unique identifier of the database whose status you want to retrieve.

Response

status
string
Returns "success" when the request completes successfully.
response
object
The current status details for the requested database.

Examples

curl -X GET https://api.virtuscloud.app/v2/databases/a14b8d5e1cb7405a851eb4c075506121/status \
  -H "Authorization: <api_key>"

Response Example

{
  "status": "success",
  "response": {
    "cpu": "0.54%",
    "ram": "111.32MB",
    "status": "running",
    "running": true,
    "storage": "210.1MB",
    "network": {
      "total": "16.83KB ↑ 126B ↓",
      "now": "0B ↑ 0B ↓"
    },
    "uptime": 1755028584438
  }
}