List domains

List the custom domains attached to a service and their current verification state.

GET/api/services/{id}/domainsHTTPS

Request & response examples

Request exampleServer-side

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

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

[
  {
    "id": "dom_example",
    "serviceId": "svc_example",
    "hostname": "app.example.com",
    "status": "pending",
    "port": 0
  }
]

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

idstringrequired

Service id.

Response 200

Returns the domains attached to this service. A pending domain needs DNS verification before it can receive traffic.

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

idstring

Unique identifier of this resource.

serviceIdstring

hostnamestring

Hostname assigned or attached to the service.

statusstring

Current state of the resource or operation.

portinteger

Port number for the resource.

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

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