Skip to main content
GET
/
v1
/
databases
/
status
Get All Databases Status
curl --request GET \
  --url https://api.vertracloud.app/v1/databases/status
{
  "response": [
    {
      "id": "639d9aa35d8b4e559bcd066db4ddcc8c",
      "cpu": "0.00%",
      "ram": "0.00 MB",
      "storage": "0.00 MB",
      "running": false
    },
    {
      "id": "bdd13420cc10441290ddd25961ed71e6",
      "cpu": "1.25%",
      "ram": "128.50 MB",
      "storage": "256.00 MB",
      "running": true
    }
  ]
}
​
workspace_id
string
The ID of the workspace to filter databases by. If not provided, retrieves databases owned by the user.

​
Response

​
response
array
An array of database status objects.
{
  "response": [
    {
      "id": "639d9aa35d8b4e559bcd066db4ddcc8c",
      "cpu": "0.00%",
      "ram": "0.00 MB",
      "storage": "0.00 MB",
      "running": false
    },
    {
      "id": "bdd13420cc10441290ddd25961ed71e6",
      "cpu": "1.25%",
      "ram": "128.50 MB",
      "storage": "256.00 MB",
      "running": true
    }
  ]
}

​
Error Responses

​
code
string
The error code indicating the reason for failure. Possible values:
  • UNAUTHORIZED: The user is not authenticated or lacks sufficient permissions.
  • ORGANIZATION_NOT_FOUND: The specified workspace does not exist.
  • USER_NOT_IN_ORGANIZATION: The user is not a member of the specified workspace.
​
message
string
A descriptive message providing additional details about the error.
{
  "code": "UNAUTHORIZED"
}