API reference gaps
Live Domains endpoints with no autogenerated reference page yet.
The autogenerated API reference (built from openapi.json) doesn't cover every Domains
endpoint. These are live and used by the panel today; this page is a plain, hand-written
reference until they're added to the generator's coverage.
Rename an address
POST /api/admin/domains/{hostname}/rename
| Field | Type | Notes |
|---|---|---|
new_hostname | string, 1-255 chars | A bare host, a host/slug path, or an existing domain you own |
Returns the updated domain (DomainRead). See Rename a channel address or move it to a
path for what each kind of target does.
Buy-domain search
POST /api/admin/domains/buy/search
| Field | Type | Notes |
|---|---|---|
query | string, 1-63 chars | A bare label or a full domain |
tlds | string[], optional, max 16 | Defaults to a curated list server-side |
Response: {query, results: [{domain, tld, available, cost_cents, price_cents, markup}]}.
Buy-domain order
POST /api/admin/domains/buy/order
| Field | Type | Notes |
|---|---|---|
domain | string, 3-255 chars | Must currently be available |
Response (201): {id, domain, status, price_cents, payment_ref, checkout_url}. 503 buy_domain_disabled while purchasing is off; 409 domain_unavailable; 429 too_many_open_orders.
Buy-domain list
GET /api/admin/domains/buy — no params.
Response: {items: [{id, domain, registrar, status, price_cents, cost_cents, markup, refund_due, error, created_at}]}.
Detect provider
GET /api/admin/domains/detect-provider?hostname=<host>
Response: {hostname, is_apex, provider, provider_label, parent, nameservers, our_zone}.
nameservers is capped at 4 entries; our_zone is true when the zone is already on our
Cloudflare account.
Domain reputation
GET /api/admin/domain-reputation — no params.
Response: {ts, age_seconds, stale, worst, summary: {ok, watch, burned}, domains: [{domain, status, reasons, tls_days}], gsb_enabled}. domains is sorted worst-first. See Check whether a
domain is burning for what the fields mean.
What's next
For everything else — connect, verify, claim, copy, delete — see the covered endpoints in Domains or the generated API reference where a page already exists.