hosting
POST /v1/site-blueprints
Capture a built site as a reusable blueprint.
Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão sites.blueprint.manage; uma chave sem ela é recusada com 403, e não 404.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
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> }'Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
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`.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
Idempotency-Key (header) | string | Não | Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats. |
Corpo da requisição
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
site_id | Uuid | Sim | The built site to capture. Must be `active`. |
name | string | Sim | — |
notes | string | Não | — |
backup_id | Uuid | null | Não | An 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… |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
id | Uuid | Sim | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Sim | — |
notes | string | Sim | The customer's own note, so they can tell their templates apart. |
status | SiteBlueprintStatus | Sim | Where 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… |
message | string | Não | Why a capture failed, in human English. Empty otherwise. Rendered to the customer verbatim. |
stack_type | StackType | Sim | The 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… |
runtime | Runtime | Sim | The runtime the web server serves the site with. |
product_line | string | Sim | The 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_domain | string | Sim | The domain of the site this was captured from, kept after that site is gone. |
source_site_id | Uuid | null | Sim | The site it came from, or null once that site has been deleted. |
has_screenshot | boolean | Sim | Whether 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… |
deployable | boolean | Sim | Whether 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_count | integer | Sim | How many sites have been built from this blueprint. |
created_at | string | Sim | — |
updated_at | string | Sim | — |
Erros que este endpoint pode retornar
401 · 403 · 404 · 409 · 422 · 429 · 503