Get service

Read a service’s current state, source configuration, plan, and exposed ports.

GET/api/services/{id}HTTPS

Request & response examples

Request exampleServer-side

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

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

{
  "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:read. The resource must be within the key’s project, service, and environment scope.

Authorization: Bearer <key>Key setup

Path parameters

idstringrequired

Service id.

Response 200

Returns the service record: its identity, source configuration, plan, and current state. A failed latest deployment may coexist with a serving previous release.

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

idstring

Unique identifier of this resource.

namestring

Human-readable resource name.

slugstring

URL-safe resource identifier.

sourceTypestring

Source used to build or run the service.

statusstring

Current state of the resource or operation.

planKeystring

Plan identifier from the plan catalog.

projectIdstring

Project that owns the resource.

environmentIdstring

Environment that contains the service.

Errors

401

The API key is missing, invalid, or revoked.

403

The caller or key scope does not permit this operation.

Error handling and safe retries

ALSO AVAILABLE VIA MCP

`get_service`

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

Connect your agent

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