Database
Get Database Status
Get all status info related with a single database.
GET
/
v2
/
databases
/
{database_id}
/
status
Get Database Status
curl --request GET \
--url https://api.squarecloud.app/v2/databases/{database_id}/status \
--header 'Authorization: <authorization>'import requests
url = "https://api.squarecloud.app/v2/databases/{database_id}/status"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.squarecloud.app/v2/databases/{database_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.squarecloud.app/v2/databases/{database_id}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$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.squarecloud.app/v2/databases/{database_id}/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
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.squarecloud.app/v2/databases/{database_id}/status")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/databases/{database_id}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"status": "success",
"response": {
"cpu": "0.54%",
"ram": "111.32MB",
"status": "running",
"running": true,
"storage": "210.1MB",
"network": {
"total": "16.83KB ↑ 126B ↓",
"now": "0B ↑ 0B ↓"
},
"uptime": 1755028584438
}
}
string
required
The API key for your account. You can find this in your account settings.
rawData=true to get raw numeric values instead of the formatted strings ("0.54%", "111.32MB") shown in the example below, useful when you want to do your own formatting or math client-side.
To fetch this for every owned database at once, use All Databases Status. For historical trends instead of a live reading, see Get Database Metrics.
Parameters
string
required
The ID of the database.
boolean
If you want raw data. True, returns the values in bytes.
Response
string
Indicates whether the call was successful..
success if successful, error if not.object
The contents of the response.
Show Toggle object
Show Toggle object
{
"status": "success",
"response": {
"cpu": "0.54%",
"ram": "111.32MB",
"status": "running",
"running": true,
"storage": "210.1MB",
"network": {
"total": "16.83KB ↑ 126B ↓",
"now": "0B ↑ 0B ↓"
},
"uptime": 1755028584438
}
}
Common errors
| Code | HTTP | Meaning |
|---|---|---|
DATABASE_NOT_FOUND | 404 | The database does not exist or is not owned by the caller. |
⌘I
Get Database Status
curl --request GET \
--url https://api.squarecloud.app/v2/databases/{database_id}/status \
--header 'Authorization: <authorization>'import requests
url = "https://api.squarecloud.app/v2/databases/{database_id}/status"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.squarecloud.app/v2/databases/{database_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.squarecloud.app/v2/databases/{database_id}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$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.squarecloud.app/v2/databases/{database_id}/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
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.squarecloud.app/v2/databases/{database_id}/status")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/databases/{database_id}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"status": "success",
"response": {
"cpu": "0.54%",
"ram": "111.32MB",
"status": "running",
"running": true,
"storage": "210.1MB",
"network": {
"total": "16.83KB ↑ 126B ↓",
"now": "0B ↑ 0B ↓"
},
"uptime": 1755028584438
}
}