List backups

List the backup records for a managed database.

GET/api/services/{id}/backupsHTTPS

Request & response examples

Request exampleServer-side

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

const response = await fetch(
  "https://app.helicarrier.xyz/api/services/YOUR_ID/backups",
  {
    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/backups",
    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 example200

[
  {
    "id": "bak_example",
    "serviceId": "svc_example",
    "engine": "postgres",
    "status": "complete",
    "sizeBytes": 1048576,
    "createdAt": "2026-10-07T12:00:00Z",
    "finishedAt": "2026-10-07T12:00:00Z",
    "tier": "Latest"
  }
]

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

idstringrequired

Database service id.

Response 200

Returns this database’s backup records. An empty array means no backups were returned. Check completion before attempting a restore.

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

idstring

Unique identifier of this resource.

serviceIdstring

enginestring

Database engine key.

statusstring

Current state of the resource or operation.

sizeBytesinteger

Backup size in bytes.

createdAtstring

Resource creation timestamp.

finishedAtstring

Completion timestamp; can be empty while the operation is running.

tierstring

Rolling-retention tier assigned to a completed backup.

Errors

401

The API key is missing, invalid, or revoked.

403

The caller or key scope does not permit this operation.

500

The operation could not be completed. Check resource state before retrying a write.

Error handling and safe retries

ALSO AVAILABLE VIA MCP

`list_backups`

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/backups", headers={ "Authorization": f"Bearer {os.environ['HELI_API_KEY']}" }, timeout=30, ) response.raise_for_status() data = response.json() # Inspect data; avoid logging secret responses.

[ { "id": "bak_example", "serviceId": "svc_example", "engine": "postgres", "status": "complete", "sizeBytes": 1048576, "createdAt": "2026-10-07T12:00:00Z", "finishedAt": "2026-10-07T12:00:00Z", "tier": "Latest" } ]