Update build settings

Update the build directory, builder, and build or runtime commands for a service.

PATCH/api/services/{id}/buildHTTPS

Request & response examples

Request exampleServer-side

curl --fail-with-body --request PATCH \
  'https://app.helicarrier.xyz/api/services/YOUR_ID/build' \
  -H "Authorization: Bearer $HELI_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "rootDir": "apps/api",
  "buildCommand": "npm run build",
  "startCommand": "npm start"
}'

const response = await fetch(
  "https://app.helicarrier.xyz/api/services/YOUR_ID/build",
  {
    method: "PATCH",
    headers: {
      Authorization: `Bearer ${process.env.HELI_API_KEY}`,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "rootDir": "apps/api",
      "buildCommand": "npm run build",
      "startCommand": "npm start"
    })
  }
);
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/services/YOUR_ID/build",
    headers={
        "Authorization": f"Bearer {os.environ['HELI_API_KEY']}"
    },
    json={
      "rootDir": "apps/api",
      "buildCommand": "npm run build",
      "startCommand": "npm start"
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
# Inspect data; avoid logging secret responses.

Response example200

{
  "id": "svc_example",
  "name": "my-app",
  "slug": "my-app",
  "sourceType": "image",
  "status": "running",
  "planKey": "heli-s1",
  "projectId": "prj_example",
  "environmentId": "env_example",
  "rootDir": "apps/api",
  "buildCommand": "npm run build",
  "startCommand": "npm start"
}

Illustrative values · selected fields

Response details OpenAPI

Authorization

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

Authorization: Bearer <key>Key setup

Path parameters

idstringrequired

Service id.

Request bodyapplication/json

rootDirstringoptional

Subdir the app lives in, e.g. apps/api. Empty for the repo root.

installCommandstringoptional

Install override, e.g. npm ci.

buildCommandstringoptional

Build override, e.g. npm run build.

startCommandstringoptional

Start command; for a static site, the output directory.

dockerfilePathstringoptional

Path to a Dockerfile relative to the root dir.

releaseCommandstringoptional

Command run once before each release (migrations).

builderstringoptional

"" auto | railpack | dockerfile | next.

Response 200

Returns the updated service. Saved build and runtime settings apply on the next deployment.

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

idstring

Unique identifier of this resource.

namestring

Human-readable resource name.

slugstring

URL-safe resource identifier.

sourceTypestring

Source used to build or run the service.

statusstring

Current state of the resource or operation.

planKeystring

Plan identifier from the plan catalog.

projectIdstring

Project that owns the resource.

environmentIdstring

Environment that contains the service.

rootDirstring

buildCommandstring

startCommandstring

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.

500

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

Error handling and safe retries

ALSO AVAILABLE VIA MCP

`update_build_settings`

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

Connect your agent

curl --fail-with-body --request PATCH \ 'https://app.helicarrier.xyz/api/services/YOUR_ID/build' \ -H "Authorization: Bearer $HELI_API_KEY" \ -H 'Content-Type: application/json' \ --data '{ "rootDir": "apps/api", "buildCommand": "npm run build", "startCommand": "npm start" }'

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

{ "id": "svc_example", "name": "my-app", "slug": "my-app", "sourceType": "image", "status": "running", "planKey": "heli-s1", "projectId": "prj_example", "environmentId": "env_example", "rootDir": "apps/api", "buildCommand": "npm run build", "startCommand": "npm start" }