Skip to main content
GET
/
v1
/
databases
/
{id}
/
status
Get Database Status by ID
curl --request GET \
  --url https://api.vertracloud.app/v1/databases/{id}/status
{
  "response": {
    "cpu": 12.3,
    "ram": 256,
    "storage": 512,
    "status": "running",
    "running": true,
    "network": {
      "total": "320.15KB ↓ 20.10KB ↑",
      "now": "5.00KB ↑ 1.00KB ↓"
    },
    "uptime": 7200,
    "created_at": "2026-03-09T15:51:47.234Z",
    "updated_at": "2026-03-11T15:06:41.449Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.vertracloud.app/llms.txt

Use this file to discover all available pages before exploring further.

​
id
string
required
The ID of the database to retrieve status for. If the database belongs to an workspace, include the workspace_id in the format dbId-workspace_id.

​
Response

​
response
object
The status and resource usage details of the database.
{
  "response": {
    "cpu": 12.3,
    "ram": 256,
    "storage": 512,
    "status": "running",
    "running": true,
    "network": {
      "total": "320.15KB ↓ 20.10KB ↑",
      "now": "5.00KB ↑ 1.00KB ↓"
    },
    "uptime": 7200,
    "created_at": "2026-03-09T15:51:47.234Z",
    "updated_at": "2026-03-11T15:06:41.449Z"
  }
}

​
Error Responses

​
code
string
The error code indicating the reason for failure. Possible values:
  • DATABASE_NOT_FOUND: The specified database does not exist.
  • FORBIDDEN: The user does not have permission to access the database.
  • INTERNAL_SERVER_ERROR: An error occurred while retrieving the status.
​
message
string
A descriptive message providing additional details about the error.
{
  "code": "DATABASE_NOT_FOUND"
}