List dedicated IPs

List dedicated outbound addresses held by your account and their attachments.

GET/api/dedicated-ipsHTTPS

Request & response examples

Request exampleServer-side

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

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

{
  "held": 1,
  "ips": [
    {
      "id": "ip_example",
      "address": "203.0.113.10",
      "label": "Production",
      "attachments": []
    }
  ],
  "canManage": true
}

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

Parameters

This request does not require path, query, or body parameters.

Response 200

Returns dedicated IPs held by your account and whether you can manage them. Acquisition and payment are handled in the dashboard.

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

heldinteger

Number of held addresses.

ipsarray

Dedicated IPs held by this account.

Child fields

idstring
Unique identifier of this resource.
addressstring
labelstring
Human-readable label.
attachmentsarray

canManageboolean

Whether the caller can manage these addresses.

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

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