Restore service

Restore an eligible deleted service and redeploy it with its retained configuration.

POST/api/services/{id}/restoreHTTPS

Request & response examples

Request exampleServer-side

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

const response = await fetch(
  "https://app.helicarrier.xyz/api/services/YOUR_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/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",
  "id": "svc_example",
  "slug": "my-app"
}

Illustrative values · selected fields

Response details OpenAPI

Authorization

An account key with access, or a project key with project:write. A service key cannot perform this operation.

Authorization: Bearer <key>Key setup

Path parameters

idstringrequired

Service id.

Response 200

Restores an eligible deleted service and redeploys it. The restored identifier is the same; inspect the service to follow recovery.

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

statusstring

Current state of the resource or operation.

idstring

Unique identifier of this resource.

slugstring

URL-safe resource identifier.

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.

500

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

Error handling and safe retries

ALSO AVAILABLE VIA MCP

`restore_service`

Required MCP arguments: id. 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/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.