List dependents

List the services that connect to this one. Check this before rotating a database or bucket credential: those services are redeployed to pick up the new one.

GET/api/services/{id}/dependentsHTTPS

Request & response examples

Request exampleServer-side

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

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

{
  "dependents": [
    {
      "id": "svc_example",
      "slug": "my-app",
      "status": "active"
    },
    {
      "id": "svc_worker",
      "slug": "my-worker",
      "status": "active"
    }
  ]
}

Illustrative values · selected fields

Response details OpenAPI

Authorization

An account key with access, or a project/service key with deployments:read. The resource must be within the key’s project, service, and environment scope.

Authorization: Bearer <key>Key setup

Path parameters

idstringrequired

Database, bucket or any provider service id.

Response 200

Returns the services that connect to this one, with their current status. Only services you have access to are listed; when some are in environments you cannot access, a hidden count is returned alongside them and rotating this service's credentials is refused.

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

dependentsarray

Child fields

idstring
Unique identifier of this resource.
slugstring
URL-safe resource identifier.
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.

Error handling and safe retries

ALSO AVAILABLE VIA MCP

`list_dependents`

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