List deployments

Read deployment history for a service, newest first, with rollback eligibility and a pagination cursor.

GET/api/services/{id}/deploymentsHTTPS

Request & response examples

Request exampleServer-side

curl --fail-with-body --request GET \
  'https://app.helicarrier.xyz/api/services/YOUR_ID/deployments?limit=25' \
  -H "Authorization: Bearer $HELI_API_KEY"

const response = await fetch(
  "https://app.helicarrier.xyz/api/services/YOUR_ID/deployments?limit=25",
  {
    method: "GET",
    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(
    "GET",
    "https://app.helicarrier.xyz/api/services/YOUR_ID/deployments?limit=25",
    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

{
  "deployments": [
    {
      "id": "dep_example",
      "serviceId": "svc_example",
      "status": "active",
      "rollbackable": true,
      "createdAt": "2026-10-07T12:00:00Z"
    }
  ],
  "nextCursor": 0
}

Illustrative values · selected fields

Response details OpenAPI

Authorization

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

Authorization: Bearer <key>Key setup

Path parameters

idstringrequired

Service id.

Query parameters

limitintegeroptional

Max rows.

beforeintegeroptionalREST only

Return older deployments using the nextCursor value from the previous response. REST only; this parameter is not exposed by the MCP tool.

Response 200

Returns { "deployments": [...], "nextCursor": ... }, newest first. Pass nextCursor as before to retrieve the next REST page. Each deployment includes rollbackable; only eligible retained images can be rolled back to.

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

deploymentsarray

Deployment records, ordered newest first.

Child fields

idstring
Unique identifier of this resource.
serviceIdstring
statusstring
Current state of the resource or operation.
rollbackableboolean
Whether a retained deployment image is eligible for rollback.
createdAtstring
Resource creation timestamp.

nextCursorinteger

Pass as before to read the next page. Zero means no next page.

Errors

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

`list_deployments`

Required MCP arguments: id. Send path, query, and body fields together as tool arguments. Parameters marked REST only are not available through this tool.

Connect your agent

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

{ "deployments": [ { "id": "dep_example", "serviceId": "svc_example", "status": "active", "rollbackable": true, "createdAt": "2026-10-07T12:00:00Z" } ], "nextCursor": 0 }