Get DNS target

Get the DNS target to use when connecting a custom domain to this service.

GET /api/services/{id}/dns HTTPS

Request & response examples

Request example Server-side

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

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

{
  "cnameTarget": "YOUR_SERVICE_HOSTNAME",
  "ip": "203.0.113.10"
}

Illustrative values · selected fields

Response details ↓ OpenAPI ↗

Authorization

An account key with access, or a project/service key with domains:read. The resource must be within the key’s project, service, and environment scope.

Authorization: Bearer <key> Key setup ↗

Path parameters

id string required

Service id.

Response 200

Returns the CNAME target and IP address for this service. Use the values returned by your own request when configuring DNS.

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

cnameTarget string

CNAME target to use for this service.

ip string

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

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

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