List references

List environment-variable references connecting this service to provider services.

GET/api/services/{id}/referencesHTTPS

Request & response examples

Request exampleServer-side

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

const response = await fetch(
  "https://app.helicarrier.xyz/api/services/YOUR_ID/references",
  {
    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/references",
    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": "ref_example",
    "varKey": "DATABASE_URL",
    "sourceKind": "url",
    "providerId": "svc_database",
    "providerName": "postgres",
    "providerEnvironment": ""
  }
]

Illustrative values · selected fields

Response details OpenAPI

Authorization

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

Authorization: Bearer <key>Key setup

Path parameters

idstringrequired

Service id.

Response 200

Returns each injected variable and its provider service. providerEnvironment is empty when the provider is in the same environment.

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

idstring

Unique identifier of this resource.

varKeystring

sourceKindstring

providerIdstring

providerNamestring

providerEnvironmentstring

Provider environment label; empty for the same environment.

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_references`

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