Get service dedicated IP

Read a service’s explicit outbound IP and its project-level fallback.

GET /api/services/{id}/dedicated-ip HTTPS

Request & response examples

Request example Server-side

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

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

{
  "ip": null,
  "projectIp": {
    "id": "ip_example",
    "address": "203.0.113.10",
    "label": "Production",
    "attachments": []
  }
}

Illustrative values · selected fields

Response details ↓ OpenAPI ↗

Authorization

An account key with access to the resource. Project and service keys do not authorize this operation.

Authorization: Bearer <key> Key setup ↗

Path parameters

id string required

Service id.

Response 200

Returns the explicit service attachment as ip and the project attachment as projectIp. Either value can be null.

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

ip object | null

Attached dedicated IP, or null when detached. In DNS responses, the target IP address.

projectIp object

Project-level IP attachment inherited by the service.

Child fields

id string
Unique identifier of this resource.
address string
label string
Human-readable label.
attachments array

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_dedicated_ip`

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