Skip to main content
GET
/
v1
/
databases
/
{id}
Get Database by ID
curl --request GET \
  --url https://api.vertracloud.app/v1/databases/{id}
import requests

url = "https://api.vertracloud.app/v1/databases/{id}"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.vertracloud.app/v1/databases/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vertracloud.app/v1/databases/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vertracloud.app/v1/databases/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.vertracloud.app/v1/databases/{id}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.vertracloud.app/v1/databases/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "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"
  }
}
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"
}
{
  "code": "DATABASE_NOT_FOUND"
}