Skip to content
Helicarrier Developers

Update build settings

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

PATCH /api/services/{id}/build HTTPS
Request & response examples
Request example Server-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"
}'
Response example 200
{
"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

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

id string required

Service id.

Request body

rootDir string optional

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

installCommand string optional

Install override, e.g. npm ci.

buildCommand string optional

Build override, e.g. npm run build.

startCommand string optional

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

dockerfilePath string optional

Path to a Dockerfile relative to the root dir.

releaseCommand string optional

Command run once before each release (migrations).

builder string optional

"" 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.

id string

Unique identifier of this resource.

name string

Human-readable resource name.

slug string

URL-safe resource identifier.

sourceType string

Source used to build or run the service.

status string

Current state of the resource or operation.

planKey string

Plan identifier from the plan catalog.

projectId string

Project that owns the resource.

environmentId string

Environment that contains the service.

rootDir string
buildCommand string
startCommand string

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 ↗