hosting

POST /v1/sites/{siteId}/rename-domain

Change a site's primary domain (asynchronous).

Lahat ng hosting endpoint

Pagpapatotoo

Magpadala ng API key bilang isang bearer token. Kailangang taglayin ng key ang pahintulot na sites.create; ang key na wala nito ay tatanggihan gamit ang 403, hindi 404.

Ang endpoint na ito ay hindi nangangailangan ng id ng organisasyon. Natutukoy na ng iyong key ang organisasyong kinabibilangan nito, at nakatuon ang tugon dito.

Subukan ito

Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/rename-domain \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "new_domain": <Hostname> }'

Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API

Mga Detalye

Starts the durable **rename-domain** saga for a site (new-side setup → flip → old-side teardown, register #91). Returns `202 Accepted` immediately — the work runs as a Temporal workflow; poll the site or subscribe to `site.*` events for completion. Requires `sites.create` (the same authority that provisions a site). Idempotent on the site: a repeat call while the saga is running is accepted and does not start a second run.

Mga Parameter

PangalanUriKailanganAno ito
siteId (path)UuidOoSite ID (UUIDv7).

Katawan ng kahilingan

PangalanUriKailanganAno ito
new_domainHostnameOoThe site's new primary domain (FQDN).
keep_old_as_aliasbooleanHindiKeep serving the old domain as an alias of the site after the flip.

Tugon

PangalanUriKailanganAno ito
site_idUuidOoUUIDv7 identifier — sortable by creation time (docs/02 §8).
new_domainHostnameOoA fully-qualified DNS hostname, lowercase, no trailing dot.
workflow_idstringOoThe Temporal workflow id running the rename saga (deterministic per site).
statusstring<accepted>OoThe saga was accepted; poll the site / `site.*` events for completion.

Mga error na maibabalik ng endpoint na ito

401 · 403 · 404 · 409 · 422 · 429 · 503