Skip to main content
GET
/
v2
/
databases
/
status
All Databases Status
curl --request GET \
  --url https://api.squarecloud.app/v2/databases/status \
  --header 'Authorization: <authorization>'
import requests

url = "https://api.squarecloud.app/v2/databases/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/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/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/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/status")
  .header("Authorization", "<authorization>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/databases/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": [
        {
            "id": "a14b8d5e1cb7405a851eb4c075506121",
            "running": true,
            "ram": "118.95MB",
            "cpu": "0.40%"
        }
    ]
}
​
Authorization
string
required
The API key for your account. You can find this in your account settings.
Returns live runtime stats, whether it’s running, CPU and RAM usage, for every database owned by the caller in a single call. Use it to render a dashboard overview instead of calling Get Database Status once per database. This collection form is rate limited to 15 requests per 60 seconds per user, with a 60-second block once that cap is hit; the single-database form is not subject to this limit. For historical CPU/RAM/network trends instead of a live snapshot, see Get Database Metrics.

​
Response

​
status
string
Indicates whether the call was successful.. success if successful, error if not.
​
response
array
The contents of the response.
{
    "status": "success",
    "response": [
        {
            "id": "a14b8d5e1cb7405a851eb4c075506121",
            "running": true,
            "ram": "118.95MB",
            "cpu": "0.40%"
        }
    ]
}