Skip to main content
GET
https://api.vertracloud.app
/
v1
/
databases
/
{id}
Get Database by ID
curl --request GET \
  --url https://api.vertracloud.app/v1/databases/{id}
{
  "status": "success",
  "response": {
    "id": "639d9aa35d8b4e559bcd066db4ddcc8c",
    "cluster": 1,
    "type": 3,
    "name": "MyDatabase",
    "description": "I have a description :)",
    "owner_id": "993591427428790342",
    "owner_plan_id": 1,
    "status": "up",
    "storage": 512,
    "ram": 256,
    "host": "vertra-cloud-redis-639d9aa35d8b4e559bcd066db4ddcc8c.db.vertraweb.app",
    "port": 6379,
    "duration": 30,
    "expires_at": "2025-09-14T19:58:00Z",
    "plan_id": 1,
    "purchased_at": "2025-08-14T19:58:00Z",
    "last_backup": "2025-08-14T19:58:00Z",
    "created_at": "2025-08-14T19:58:00Z",
    "updated_at": "2025-08-14T19:58:00Z"
  }
}
​
id
string
required
The ID of the database to retrieve. If the database belongs to an organization, include the organization ID in the format dbId-orgId.

​
Response

​
status
string
Indicates whether the call was successful. success if successful, error if not.
​
response
object
The details of the database.
{
  "status": "success",
  "response": {
    "id": "639d9aa35d8b4e559bcd066db4ddcc8c",
    "cluster": 1,
    "type": 3,
    "name": "MyDatabase",
    "description": "I have a description :)",
    "owner_id": "993591427428790342",
    "owner_plan_id": 1,
    "status": "up",
    "storage": 512,
    "ram": 256,
    "host": "vertra-cloud-redis-639d9aa35d8b4e559bcd066db4ddcc8c.db.vertraweb.app",
    "port": 6379,
    "duration": 30,
    "expires_at": "2025-09-14T19:58:00Z",
    "plan_id": 1,
    "purchased_at": "2025-08-14T19:58:00Z",
    "last_backup": "2025-08-14T19:58:00Z",
    "created_at": "2025-08-14T19:58:00Z",
    "updated_at": "2025-08-14T19:58:00Z"
  }
}

​
Error Responses

​
status
string
Indicates whether the call was successful. error if not successful.
​
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.
{
  "status": "error",
  "code": "UNAUTHORIZED"
}