Remove domain

Remove a custom domain from this service.

DELETE /api/services/{id}/domains/{domainId} HTTPS

Request & response examples

Request example Server-side

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

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

{
  "status": "removed"
}

Illustrative values · selected fields

Response details ↓ OpenAPI ↗

Authorization

An account key with access, or a project/service key with domains:write. 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.

domainId string required

Domain id.

Response 200

Removes this custom domain from the service. DNS records at your DNS provider are not modified.

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

status string

Current state of the resource or operation.

Errors

400

Invalid parameters. Check the required fields, types, and resource configuration.

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

`remove_domain`

Required MCP arguments: id, domainId. Send path, query, and body fields together as tool arguments.

Connect your agent ↗

import os import requests response = requests.request( "DELETE", "https://app.helicarrier.xyz/api/services/YOUR_ID/domains/YOUR_DOMAIN_ID", headers={ "Authorization": f"Bearer {os.environ['HELI_API_KEY']}" }, timeout=30, ) response.raise_for_status() data = response.json() # Inspect data; avoid logging secret responses.