Set service image

Change a service’s container image and optionally deploy it immediately.

PATCH /api/services/{id}/image HTTPS

Request & response examples

Request example Server-side

curl --fail-with-body --request PATCH \
  'https://app.helicarrier.xyz/api/services/YOUR_ID/image' \
  -H "Authorization: Bearer $HELI_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "image": "nginx:stable"
}'

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

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

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

id string required

Service id.

Request body application/json

image string required

New image reference, e.g. ghcr.io/acme/api:v1.2.3.

deploy boolean optional

Deploy immediately after repointing.

Response 200 / 202

Returns the updated service when saving only (200), or a deploymentId and image when a deployment is queued (202).

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.

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.

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

`set_service_image`

Required MCP arguments: id, image. 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/image' \ -H "Authorization: Bearer $HELI_API_KEY" \ -H 'Content-Type: application/json' \ --data '{ "image": "nginx:stable" }'

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