Get database metrics

GET

databases

{database_id}

metrics

curl --request GET \
  --url https://api.squarecloud.app/v2/databases/{database_id}/metrics \
  --header 'Authorization: <authorization>'

import requests

url = "https://api.squarecloud.app/v2/databases/{database_id}/metrics"

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}/metrics', 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}/metrics",
  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}/metrics"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/databases/{database_id}/metrics")

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": [
        {
            "date": "2025-08-13T12:55:01.348Z",
            "cpu": 0.45,
            "ram": 111.27,
            "net": [
                16834,
                126
            ],
            "disk": [
                7544832,
                1310720
            ],
            "storage": 11083776
        },
        {
            "date": "2025-08-13T12:50:01.349Z",
            "cpu": 0.45,
            "ram": 111.22,
            "net": [
                16834,
                126
            ],
            "disk": [
                7544832,
                1179648
            ],
            "storage": 11079680
        },
        {
            "date": "2025-08-13T12:45:01.350Z",
            "cpu": 0.58,
            "ram": 111.36,
            "net": [
                16834,
                126
            ],
            "disk": [
                7540736,
                1048576
            ],
            "storage": 11075584
        },
        {
            "date": "2025-08-13T12:40:01.348Z",
            "cpu": 0.43,
            "ram": 118.44,
            "net": [
                16834,
                126
            ],
            "disk": [
                7540736,
                1048576
            ],
            "storage": 11075584
        }
    ]
}

string

required

The API key for your account. You can find this in your account settings.

Requires an API key with the databases:read scope. Returns historical CPU, RAM, network, disk I/O and storage usage for a database, sampled every 5 minutes over the last 24 hours (up to 288 points), newest first. On Pro and Enterprise plans, range=7d returns the last 7 days instead, one point per hour with the hour’s average and peak. Use it to plot usage graphs or to decide whether the database needs more memory before calling Edit Database. For a single current reading instead of a time series, use Get Database Status. Responses are cached for 2.5 minutes per user and database (10 minutes for 7d), and the endpoint is rate limited to 10 requests per 5 seconds per user, with a short block once that cap is hit. A database with no recent samples returns an empty array rather than an error.

Parameters

string

required

The ID of the database.

string

default:"24h"

The history window: 24h (one point every 5 minutes) or 7d (one point per hour, Pro and Enterprise plans). On other plans, 7d returns the last 24 hours instead of an error.

Response

string

Indicates whether the call was successful: success if it was, error if not.

array

The contents of the response.

Show properties

string

The date in ISO format.

number

The current CPU usage percentage.

number

The current RAM usage in MB.

int[]

An array representing total network used. First the input, second the output. With range=7d, the totals are counted from the oldest point, so the difference between two consecutive points is the traffic of that hour.

int[]

An array representing total disk I/O in bytes. First the bytes read, second the bytes written. With the default 24h range, the totals are counted since the database started, so the difference between two consecutive points is the I/O of that interval, and a total lower than at the point before it in time means the database restarted. With range=7d, the totals are counted from the oldest point, so the difference between two consecutive points is the I/O of that hour. null on a 24h point that has no reading, for example a point recorded before this field existed.

number

The disk space the database is using at the given point in time, in bytes (with range=7d, at the end of that hour). null when there is no reading. Use it to follow how disk usage grows over time.

number

Only with range=7d: the highest CPU usage percentage within the hour (cpu is the hour’s average).

number

Only with range=7d: the highest RAM usage in MB within the hour (ram is the hour’s average).

{
    "status": "success",
    "response": [
        {
            "date": "2025-08-13T12:55:01.348Z",
            "cpu": 0.45,
            "ram": 111.27,
            "net": [
                16834,
                126
            ],
            "disk": [
                7544832,
                1310720
            ],
            "storage": 11083776
        },
        {
            "date": "2025-08-13T12:50:01.349Z",
            "cpu": 0.45,
            "ram": 111.22,
            "net": [
                16834,
                126
            ],
            "disk": [
                7544832,
                1179648
            ],
            "storage": 11079680
        },
        {
            "date": "2025-08-13T12:45:01.350Z",
            "cpu": 0.58,
            "ram": 111.36,
            "net": [
                16834,
                126
            ],
            "disk": [
                7540736,
                1048576
            ],
            "storage": 11075584
        },
        {
            "date": "2025-08-13T12:40:01.348Z",
            "cpu": 0.43,
            "ram": 118.44,
            "net": [
                16834,
                126
            ],
            "disk": [
                7540736,
                1048576
            ],
            "storage": 11075584
        }
    ]
}

Common errors

Code	HTTP	Meaning
`INVALID_PARAMETERS`	400	`range` is not `24h` or `7d`.
`DATABASE_NOT_FOUND`	404	The database does not exist or is not owned by the caller.

CLI: squarecloud db metrics
SDKs: api.databases.metrics() (JavaScript), client.databases.metrics() (Python), c.Databases.Metrics() (Go)

Get database metrics

curl --request GET \
  --url https://api.squarecloud.app/v2/databases/{database_id}/metrics \
  --header 'Authorization: <authorization>'

import requests

url = "https://api.squarecloud.app/v2/databases/{database_id}/metrics"

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}/metrics', 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}/metrics",
  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}/metrics"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/databases/{database_id}/metrics")

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": [
        {
            "date": "2025-08-13T12:55:01.348Z",
            "cpu": 0.45,
            "ram": 111.27,
            "net": [
                16834,
                126
            ],
            "disk": [
                7544832,
                1310720
            ],
            "storage": 11083776
        },
        {
            "date": "2025-08-13T12:50:01.349Z",
            "cpu": 0.45,
            "ram": 111.22,
            "net": [
                16834,
                126
            ],
            "disk": [
                7544832,
                1179648
            ],
            "storage": 11079680
        },
        {
            "date": "2025-08-13T12:45:01.350Z",
            "cpu": 0.58,
            "ram": 111.36,
            "net": [
                16834,
                126
            ],
            "disk": [
                7540736,
                1048576
            ],
            "storage": 11075584
        },
        {
            "date": "2025-08-13T12:40:01.348Z",
            "cpu": 0.43,
            "ram": 118.44,
            "net": [
                16834,
                126
            ],
            "disk": [
                7540736,
                1048576
            ],
            "storage": 11075584
        }
    ]
}

Get started

Account

Applications

Databases

Workspaces

AI

Parameters

Response

Common errors

​Parameters

​Response

​Common errors

​Related

Parameters

Response

Common errors

Related