Get project dedicated IP

Read the outbound IP attachment inherited by eligible services in this project.

GET /api/projects/{slug}/dedicated-ip HTTPS

Request & response examples

Request example Server-side

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

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

slug string required

Project slug.

Response 200

Returns the project attachment as ip, or null if none is attached.

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

ip object

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

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

Required MCP arguments: slug. 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/projects/my-project/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.