hosting

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

Change a site's primary domain (asynchronous).

אימות

שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה sites.create; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.

נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

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> }'

מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API

פרטים

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.

פרמטרים

שם	סוג	נדרש	מה זה
`siteId (path)`	`Uuid`	כן	Site ID (UUIDv7).

גוף הבקשה

שם	סוג	נדרש	מה זה
`new_domain`	`Hostname`	כן	The site's new primary domain (FQDN).
`keep_old_as_alias`	`boolean`	לא	Keep serving the old domain as an alias of the site after the flip.

תשובה

שם	סוג	נדרש	מה זה
`site_id`	`Uuid`	כן	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`new_domain`	`Hostname`	כן	A fully-qualified DNS hostname, lowercase, no trailing dot.
`workflow_id`	`string`	כן	The Temporal workflow id running the rename saga (deterministic per site).
`status`	`string<accepted>`	כן	The saga was accepted; poll the site / `site.*` events for completion.

שגיאות שנקודה קצה זו עשויה להחזיר

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

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