GET

List Enabled Domains

/api/v1/external/links/enabled-domains

Returns all domains available for use as the domain_id when creating a link. The list includes Hozip's platform domains and any active custom domains configured on your account. Results are sorted alphabetically.

We recommend calling this endpoint once at startup and caching the result — domain availability changes infrequently.

Authentication

Authorization: Token YOUR_API_KEY

Query Parameters

This endpoint has no query parameters.

Response 200 OK

A JSON object with a results array. Items are sorted alphabetically by domain. 

{
  "results": [
    {
      "id": "018e0000-3d4e-7f8a-9b0c-1d2e3f4a5b6c",
      "domain": "hozip.link"
    },
    {
      "id": "018e0001-3d4e-7f8a-9b0c-1d2e3f4a5b6c",
      "domain": "yourdomain.com"
    }
  ]
}
Field Type Description
results[].id string (UUID) Domain identifier. Pass this as domain_id when creating a link.
results[].domain string The domain hostname.

Error Responses

Status Description
401 Missing or invalid API key.

Examples

cURL

curl -H "Authorization: Token YOUR_API_KEY" \
https://hozip.com/api/v1/external/links/enabled-domains

Python (requests)

import requests
resp = requests.get(
    "https://hozip.com/api/v1/external/links/enabled-domains",
    headers={"Authorization": "Token YOUR_API_KEY"},
)
resp.raise_for_status()
domains = resp.json()["results"]
# Pick a domain ID to use when creating a link
domain_id = domains[0]["id"]
Documentation