hosting
POST /v1/sites/{siteId}/site-blueprint-deploy
Replace a site's content with a blueprint's.
Autentikasi
Kirimkan kunci API sebagai token bearer. Titik akhir ini tidak menyatakan izin tertentu dalam spesifikasi, jadi berikan kunci Anda izin minimum yang diperlukan dan periksa responsnya alih-alih berasumsi.
Endpoint ini tidak memerlukan id organisasi. Kunci Anda telah mengidentifikasi organisasi tempatnya berafiliasi, dan respons akan dibatasi untuk organisasi tersebut.
Coba
Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/site-blueprint-deploy \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "blueprint_id": <Uuid> }'Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API
Detail
⛔ **Destructive.** This overwrites the site's live database and files with the contents of the named blueprint, then rewrites the restored content's stored web addresses to this site's domain (a WordPress database names its own URLs, so without that step the new site would redirect its visitors to the old one). Its own path on the **site**, beside `backups/restore`, rather than a verb on the blueprint — the destruction happens here, so it is gated on `hosting.backup.manage` and cannot be reached by varying the body of anything gentler. ⛔ A blueprint captured from a different **stack** is refused with a `422` (`stack_mismatch`) — WordPress can only be deployed onto WordPress. So is one from a different **hosting platform** (`platform_mismatch`), whose archive our adapter cannot restore here. A blueprint belonging to a **different account** is refused with `org_mismatch`, even when your token can reach both: hierarchical tenancy means a reseller's key spans every client organisation, and a blueprint is that site's whole database — it never crosses between accounts. A blueprint that is still being captured is `blueprint_not_ready`. A deploy already in flight on this site is a `409`. The refusal is a **machine code**, carried in `error.details[0].code`, so a client can render it in the customer's own language; `error.message` is the English equivalent for a caller with no catalogue. ⛔ Read the code from `details`, not from `error.code` — that is the generic `UNPROCESSABLE_ENTITY` for every 422 this API produces.
Parameter
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
siteId (path) | Uuid | Ya | Site ID (UUIDv7). |
Idempotency-Key (header) | string | Tidak | Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats. |
Isi permintaan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
blueprint_id | Uuid | Ya | The SITE blueprint to deploy. ⛔ Always named explicitly — never "the latest". This overwrites a live site. |
Tanggapan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
id | Uuid | Ya | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
blueprint_id | Uuid | Ya | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | Uuid | Ya | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
status | SiteBlueprintDeployStatus | Ya | ⭐ `waiting` is a real state and not a synonym for `pending`. A deploy started from the create form cannot restore anything until the new site has finished provisioning, which ta… |
message | string | Tidak | Why it failed, or — after a successful restore whose URL rewrite did not take — what still needs attention. Rendered to the customer verbatim. |
started_at | object | Tidak | — |
finished_at | object | Tidak | — |
created_at | string | Ya | — |
Kesalahan yang dapat dikembalikan oleh titik akhir ini
401 · 403 · 404 · 409 · 422 · 429 · 503