Get All Databases Status
curl --request GET \
--url https://api.vertracloud.app/v1/databases/statusimport requests
url = "https://api.vertracloud.app/v1/databases/status"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.vertracloud.app/v1/databases/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/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/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/status")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vertracloud.app/v1/databases/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": [
{
"id": "00000000000000000000000000000001",
"cpu": "0.00%",
"ram": "0.00 MB",
"storage": "0.00 MB",
"running": false
},
{
"id": "00000000000000000000000000000002",
"cpu": "1.25%",
"ram": "128.50 MB",
"storage": "256.00 MB",
"running": true
}
]
}
Databases
Get All Databases Status
Retrieves the status of all databases owned by the authenticated user or within a specified workspace.
GET
/
v1
/
databases
/
status
Get All Databases Status
curl --request GET \
--url https://api.vertracloud.app/v1/databases/statusimport requests
url = "https://api.vertracloud.app/v1/databases/status"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.vertracloud.app/v1/databases/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/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/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/status")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vertracloud.app/v1/databases/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": [
{
"id": "00000000000000000000000000000001",
"cpu": "0.00%",
"ram": "0.00 MB",
"storage": "0.00 MB",
"running": false
},
{
"id": "00000000000000000000000000000002",
"cpu": "1.25%",
"ram": "128.50 MB",
"storage": "256.00 MB",
"running": true
}
]
}
string
The ID of the workspace to filter databases by. If not provided, retrieves databases owned by the user.
Response
array
An array of database status objects.
Show Toggle object
Show Toggle object
{
"response": [
{
"id": "00000000000000000000000000000001",
"cpu": "0.00%",
"ram": "0.00 MB",
"storage": "0.00 MB",
"running": false
},
{
"id": "00000000000000000000000000000002",
"cpu": "1.25%",
"ram": "128.50 MB",
"storage": "256.00 MB",
"running": true
}
]
}
Error Responses
string
The error code indicating the reason for failure. Possible values:
UNAUTHORIZED: The user is not authenticated or lacks sufficient permissions.WORKSPACE_NOT_FOUND: The specified workspace does not exist.USER_NOT_IN_WORKSPACE: The user is not a member of the specified workspace.
string
A descriptive message providing additional details about the error.
{
"code": "UNAUTHORIZED"
}
{
"code": "WORKSPACE_NOT_FOUND"
}
{
"code": "USER_NOT_IN_WORKSPACE"
}