hosting

POST /v1/site-blueprints

Capture a built site as a reusable blueprint.

Dhammaan hosting bixiyayaasha

Xaqiijinta aqoonsiga

U dir furaha API ah calaamad dusha ah (bearer token). Furaha waa inuu wataa ruqadda sites.blueprint.manage; furaha aan wadan waxaa loo diidayaa 403, ee ma aha 404.

Boggan ma qaato aqoonsiga ururka. Furahaagu wuxuu horay u aqoonsanayaa ururka uu ka tirsan yahay, jawaabtuna waxay ku kooban tahay halkaas.

Isku day

Ku beddel wax kasta oo ku dhex jira qeebaha xaglaha ah qiimayaashaada, sidoo kalena haystaaha furaha ku beddel fure ka dhex muuqda dashboordigaaga.

curl -X POST https://api.zinndigital.com/v1/site-blueprints \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "site_id": <Uuid>, "name": <string> }'

Ma sign-garaysay? Qalabka API ee ku jira dashboard-kaagu wuxuu buuxiyaa aqoonsigaaga ururka ee dhabta ah iyo furahaaga gaarka ah, wuxuuna ku shaqeysiiyaa codsiga API-ga nool si aad u aragto jawaabta dhabta ah. Kani ka fur barta kontoroolka ee API

Details

Starts a durable capture — a backup of the named site, plus a screenshot of its home page — and answers `202` with the new row in `capturing`. Poll the list. Two shapes. Omit `backup_id` and a **new backup is taken**, which spends one of the site's three per-rolling-day on-demand slots and is refused with a `429` naming when the next opens. Give `backup_id` and an **existing stored backup is adopted**: the blueprint is `ready` immediately and no allowance is spent, which is what a customer wants when this morning's site is broken and last night's is the template. The site must be `active` — a template of a half-built or failed site is not a thing anybody means to make — and its hosting must be able to produce a backup at all. Requires `sites.blueprint.manage`.

Cabiraha

MagacaNoocLoo baahan yahayMaxay tahay
Idempotency-Key (header)stringMayaClient-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

Codsiga jidhkiisa

MagacaNoocLoo baahan yahayMaxay tahay
site_idUuidHaaThe built site to capture. Must be `active`.
namestringHaa
notesstringMaya
backup_idUuid | nullMayaAn existing **stored** backup of that site to adopt, instead of taking a new one. Adopting spends none of the site's three-per-rolling-day on-demand allowance and makes the blue…

Jawaab

MagacaNoocLoo baahan yahayMaxay tahay
idUuidHaaUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringHaa
notesstringHaaThe customer's own note, so they can tell their templates apart.
statusSiteBlueprintStatusHaaWhere a capture got to. `ready` means the backup behind the blueprint is restorable, not merely that the row was written — a backup that ended "on host only" (no object storage…
messagestringMayaWhy a capture failed, in human English. Empty otherwise. Rendered to the customer verbatim.
stack_typeStackTypeHaaThe stack the source site ran, **copied at capture time**. This is the compatibility axis: a blueprint can only be deployed onto a site of the same stack. Copied rather than rea…
runtimeRuntimeHaaThe runtime the web server serves the site with.
product_linestringHaaThe line the source site was on. **Advisory** — shown so a customer can tell a PBN template from a mainstream one — and deliberately NOT part of the compatibility guard: moving…
source_domainstringHaaThe domain of the site this was captured from, kept after that site is gone.
source_site_idUuid | nullHaaThe site it came from, or null once that site has been deleted.
has_screenshotbooleanHaaWhether a picture exists. ⛔ Deliberately a boolean and not a URL: minting a presigned URL is a round trip to object storage, and doing it per row on a list endpoint would put an…
deployablebooleanHaaWhether a site can be built from this **today**. Three conditions, not one: the capture finished, a backup is linked, and that backup is still restorable. A `ready` blueprint wh…
deployment_countintegerHaaHow many sites have been built from this blueprint.
created_atstringHaa
updated_atstringHaa

Cilladaha ay bartaani soo celin karto

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