Deploy service

Queue a deployment for an existing service. For a Git service, optionally select a one-off branch, tag, or commit.

POST /api/services/{id}/deploy HTTPS

Request & response examples

Request example Server-side

curl --fail-with-body --request POST \
  'https://app.helicarrier.xyz/api/services/YOUR_ID/deploy' \
  -H "Authorization: Bearer $HELI_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "ref": "main"
}'

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

Response example 202

{
  "deploymentId": "dep_example",
  "ref": "main"
}

Illustrative values · selected fields

Response details ↓ OpenAPI ↗

Authorization

An account key with access, or a project/service key with deployments: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

ref string optional

Optional branch, tag or commit SHA to build (git services only). Omit to build the tracked branch.

Response 202

Returns 202 Accepted with deploymentId and ref. The request queues work; it does not mean the deployment succeeded. Follow deployment history and build logs until the deployment completes.

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

deploymentId string

Identifier to use when reading deployment history or logs.

ref string

Git ref selected for this deployment.

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.

Error handling and safe retries

ALSO AVAILABLE VIA MCP

`deploy_service`

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

Connect your agent ↗

curl --fail-with-body --request POST \ 'https://app.helicarrier.xyz/api/services/YOUR_ID/deploy' \ -H "Authorization: Bearer $HELI_API_KEY" \ -H 'Content-Type: application/json' \ --data '{ "ref": "main" }'

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