Get scaling

Read the instance floor, autoscaling ceiling, and effective service capacity.

GET/api/services/{id}/scalingHTTPS

Request & response examples

Request exampleServer-side

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

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

{
  "minReplicas": 1,
  "maxReplicas": 4,
  "desiredReplicas": 2,
  "instances": 2,
  "autoscaleEnabled": true,
  "autoscaleCpuPct": 70,
  "autoscaleMemPct": 0,
  "autoscalable": true
}

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 scaling configuration, the effective instance count, and whether the service type supports autoscaling.

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

minReplicasinteger

Configured instance floor.

maxReplicasinteger

Configured autoscaling ceiling.

desiredReplicasinteger

Desired instance count selected by the scaler.

instancesinteger

Effective number of instances.

autoscaleEnabledboolean

Whether autoscaling is enabled.

autoscaleCpuPctinteger

CPU utilization target; zero disables this signal.

autoscaleMemPctinteger

Memory utilization target; zero disables this signal.

autoscalableboolean

Whether this service supports autoscaling.

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

`get_scaling`

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/scaling", headers={ "Authorization": f"Bearer {os.environ['HELI_API_KEY']}" }, timeout=30, ) response.raise_for_status() data = response.json() # Inspect data; avoid logging secret responses.