Attach project dedicated IP

Attach an existing account-owned outbound IP to a project.

PUT/api/projects/{slug}/dedicated-ipHTTPS

Request & response examples

Request exampleServer-side

curl --fail-with-body --request PUT \
  'https://app.helicarrier.xyz/api/projects/my-project/dedicated-ip' \
  -H "Authorization: Bearer $HELI_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "ipId": "YOUR_IP_ID"
}'

const response = await fetch(
  "https://app.helicarrier.xyz/api/projects/my-project/dedicated-ip",
  {
    method: "PUT",
    headers: {
      Authorization: `Bearer ${process.env.HELI_API_KEY}`,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ipId": "YOUR_IP_ID"
    })
  }
);
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(
    "PUT",
    "https://app.helicarrier.xyz/api/projects/my-project/dedicated-ip",
    headers={
        "Authorization": f"Bearer {os.environ['HELI_API_KEY']}"
    },
    json={
      "ipId": "YOUR_IP_ID"
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
# Inspect data; avoid logging secret responses.

Response example200

{
  "ip": {
    "id": "ip_example",
    "address": "203.0.113.10",
    "label": "Production",
    "attachments": []
  },
  "effective": "within about a minute — no redeploy needed",
  "excluded": []
}

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

slugstringrequired

Project slug.

Request bodyapplication/json

ipIdstringrequired

Dedicated IP id from list_dedicated_ips.

Response 200

Returns the attachment and effective timing. Check excluded for project services that cannot use this IP.

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

ipobject

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

Child fields

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

effectivestring

When the attachment starts applying.

excludedarray

Project services that cannot use the attachment.

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

`attach_project_dedicated_ip`

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

Connect your agent

curl --fail-with-body --request PUT \ 'https://app.helicarrier.xyz/api/projects/my-project/dedicated-ip' \ -H "Authorization: Bearer $HELI_API_KEY" \ -H 'Content-Type: application/json' \ --data '{ "ipId": "YOUR_IP_ID" }'

import os import requests response = requests.request( "PUT", "https://app.helicarrier.xyz/api/projects/my-project/dedicated-ip", headers={ "Authorization": f"Bearer {os.environ['HELI_API_KEY']}" }, json={ "ipId": "YOUR_IP_ID" }, timeout=30, ) response.raise_for_status() data = response.json() # Inspect data; avoid logging secret responses.