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
import requests

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

response = requests.get(url)

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

fetch('https://api.vertracloud.app/v1/databases/{id}/status', 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}/status",
  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}/status"

	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}/status")
  .asString();
require 'uri'
require 'net/http'

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

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": {
    "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"
  }
}
​
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"
}

{
  "code": "FORBIDDEN"
}

{
  "code": "INTERNAL_SERVER_ERROR"
}