Skip to main content
GET
/
v1
/
databases
/
{id}
Get Database by ID
curl --request GET \
  --url https://api.vertracloud.app/v1/databases/{id}
{
  "response": {
    "id": "639d9aa35d8b4e559bcd066db4ddcc8c",
    "cluster": 1,
    "type": 3,
    "name": "MyDatabase",
    "description": "I have a description :)",
    "owner_id": "993591427428790342",
    "owner_plan_id": 1,
    "status": "up",
    "ram": 256,
    "host": "639d9aa35d8b4e559bcd066db4ddcc8c.db.usa1.vertraweb.app",
    "port": 12748,
    "use_credits": false,
    "credits_used": 0,
    "offline_since": null,
    "last_snapshot": "2026-03-14T19:58:00Z",
    "created_at": "2026-03-14T19:58:00Z",
    "updated_at": "2026-03-14T19:58:00Z"
  }
}

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. If the database belongs to an workspace, include the workspace_id in the format dbId-workspace_id.

​
Response

​
response
object
The details of the database.
{
  "response": {
    "id": "639d9aa35d8b4e559bcd066db4ddcc8c",
    "cluster": 1,
    "type": 3,
    "name": "MyDatabase",
    "description": "I have a description :)",
    "owner_id": "993591427428790342",
    "owner_plan_id": 1,
    "status": "up",
    "ram": 256,
    "host": "639d9aa35d8b4e559bcd066db4ddcc8c.db.usa1.vertraweb.app",
    "port": 12748,
    "use_credits": false,
    "credits_used": 0,
    "offline_since": null,
    "last_snapshot": "2026-03-14T19:58:00Z",
    "created_at": "2026-03-14T19:58:00Z",
    "updated_at": "2026-03-14T19:58:00Z"
  }
}

​
Error Responses

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