hosting

POST /v1/sites/{siteId}/site-blueprint-deploy

Replace a site's content with a blueprint's.

Wszystkie punkty końcowe hosting

Wszystkie dokumentacje dla programistów

Uwierzytelnianie

Wyślij klucz API jako token bearer. Ten punkt końcowy nie określa konkretnego uprawnienia w specyfikacji, więc nadaj swojemu kluczowi minimum potrzebnych uprawnień i sprawdź odpowiedź zamiast zakładać.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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.

Parametry

NazwaTypWymaganeCo to jest
siteId (path)UuidTakSite ID (UUIDv7).
Idempotency-Key (header)stringNieClient-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

Treść żądania

NazwaTypWymaganeCo to jest
blueprint_idUuidTakThe SITE blueprint to deploy. ⛔ Always named explicitly — never "the latest". This overwrites a live site.

Odpowiedź

NazwaTypWymaganeCo to jest
idUuidTakUUIDv7 identifier — sortable by creation time (docs/02 §8).
blueprint_idUuidTakUUIDv7 identifier — sortable by creation time (docs/02 §8).
site_idUuidTakUUIDv7 identifier — sortable by creation time (docs/02 §8).
statusSiteBlueprintDeployStatusTakwaiting 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…
messagestringNieWhy it failed, or — after a successful restore whose URL rewrite did not take — what still needs attention. Rendered to the customer verbatim.
started_atobjectNie
finished_atobjectNie
created_atstringTak

Błędy, które ten punkt końcowy może zwrócić

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