Get database metrics

Read engine-specific database metrics, grouped for inspection.

GET /api/services/{id}/db/metrics HTTPS

Request & response examples

Request example Server-side

curl --fail-with-body --request GET \
  'https://app.helicarrier.xyz/api/services/YOUR_ID/db/metrics' \
  -H "Authorization: Bearer $HELI_API_KEY"

const response = await fetch(
  "https://app.helicarrier.xyz/api/services/YOUR_ID/db/metrics",
  {
    method: "GET",
    headers: {
      Authorization: `Bearer ${process.env.HELI_API_KEY}`
    }
  }
);
const data = await response.json();
if (!response.ok) {
  throw new Error(`HTTP ${response.status}: ${data.error}`);
}
// Inspect data; avoid logging secret responses.

import os
import requests

response = requests.request(
    "GET",
    "https://app.helicarrier.xyz/api/services/YOUR_ID/db/metrics",
    headers={
        "Authorization": f"Bearer {os.environ['HELI_API_KEY']}"
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
# Inspect data; avoid logging secret responses.

Response example 200

{
  "engine": "postgres",
  "running": true,
  "groups": []
}

Illustrative values · selected fields

Response details ↓ OpenAPI ↗

Authorization

An account key with access to the resource. Project and service keys do not authorize this operation.

Authorization: Bearer <key> Key setup ↗

Path parameters

id string required

Database service id.

Query parameters

light string optional

Pass 1 for the cheap subset (skips the queries that touch the engine), when you only need size and connection counts.

Response 200

Returns metrics grouped by engine. Inspect the error field when present: this endpoint can return HTTP 200 when the database cannot be reached.

Examples show selected response fields with illustrative values. Your response can contain additional fields.

engine string

Database engine key.

running boolean

Whether the database is running.

groups array

Engine-specific metric groups.

Errors

401

The API key is missing, invalid, or revoked.

403

The caller or key scope does not permit this operation.

Error handling and safe retries

ALSO AVAILABLE VIA MCP

`get_db_metrics`

Required MCP arguments: id. Send path, query, and body fields together as tool arguments.

Connect your agent ↗

import os import requests response = requests.request( "GET", "https://app.helicarrier.xyz/api/services/YOUR_ID/db/metrics", headers={ "Authorization": f"Bearer {os.environ['HELI_API_KEY']}" }, timeout=30, ) response.raise_for_status() data = response.json() # Inspect data; avoid logging secret responses.