Update reference

Rename the environment variable a reference injects, or switch which value it pulls from the same provider.

PATCH/api/references/{id}HTTPS

Request & response examples

Request exampleServer-side

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

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

{
  "reference": {
    "id": "ref_example",
    "consumerId": "svc_example",
    "providerId": "svc_database",
    "sourceKind": "url",
    "varKey": "MONGODB_URI"
  },
  "redeployRequired": true
}

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

Reference id (from list_references) — not a service id.

Request bodyapplication/json

varKeystringoptional

New env var name. Optional.

sourceKindstringoptional

New value to pull: "url", "host", "host-port", "public-url" (web-facing services only), or "var:NAME". Optional.

Response 200

Returns the updated reference. Redeploy the consumer to receive the renamed or changed value. The id is a reference id from list_references, not a service id.

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

referenceobject

New reference linking a consumer to a provider.

Child fields

idstring
Unique identifier of this resource.
consumerIdstring
providerIdstring
sourceKindstring
varKeystring

redeployRequiredboolean

Whether another service deployment is required.

Errors

400

Invalid parameters. Check the required fields, types, and resource configuration.

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

`update_reference`

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

Connect your agent

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