Abort deploy

Request cancellation of a deployment that is still in progress.

POST/api/deployments/{deploymentId}/abortHTTPS

Request & response examples

Request exampleServer-side

curl --fail-with-body --request POST \
  'https://app.helicarrier.xyz/api/deployments/YOUR_DEPLOYMENT_ID/abort' \
  -H "Authorization: Bearer $HELI_API_KEY"

const response = await fetch(
  "https://app.helicarrier.xyz/api/deployments/YOUR_DEPLOYMENT_ID/abort",
  {
    method: "POST",
    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(
    "POST",
    "https://app.helicarrier.xyz/api/deployments/YOUR_DEPLOYMENT_ID/abort",
    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

{
  "status": "aborting"
}

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

deploymentIdstringrequired

In-flight deployment id.

Response 200

Returns status aborting after requesting cancellation. Follow the deployment until it reaches its final state.

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

statusstring

Current state of the resource or operation.

Errors

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.

Error handling and safe retries

ALSO AVAILABLE VIA MCP

`abort_deploy`

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

Connect your agent

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