Restore backup

Restore a selected backup into its database. This overwrites the current database contents.

POST/api/services/{id}/backups/{backupId}/restoreHTTPS

Request & response examples

Request exampleServer-side

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

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

{
  "status": "restored"
}

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.

backupIdstringrequired

Backup id.

Response 200

Restoration overwrites current database data. Verify the target service and backup, and retain a current backup before executing it.

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

statusstring

Current state of the resource or operation.

Errors

401

The API key is missing, invalid, or revoked.

403

The caller or key scope does not permit this operation.

404

The resource does not exist or is not visible to this caller.

409

The current resource state prevents the operation. Inspect it before retrying.

500

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

Error handling and safe retries

ALSO AVAILABLE VIA MCP

`restore_backup`

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

Connect your agent

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