hosting
POST /v1/site-blueprints
Capture a built site as a reusable blueprint.
Аутентификация
Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение sites.blueprint.manage; ключ без него отклоняется с кодом 403, а не 404.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
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> }'Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
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.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
Idempotency-Key (header) | string | Нет | Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats. |
Тело запроса
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
site_id | Uuid | Да | The built site to capture. Must be active. |
name | string | Да | — |
notes | string | Нет | — |
backup_id | Uuid | null | Нет | 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… |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Да | — |
notes | string | Да | The customer's own note, so they can tell their templates apart. |
status | SiteBlueprintStatus | Да | 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 | Нет | Why a capture failed, in human English. Empty otherwise. Rendered to the customer verbatim. |
stack_type | StackType | Да | 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 read… |
runtime | Runtime | Да | The runtime the web server serves the site with. |
product_line | string | Да | 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 a… |
source_domain | string | Да | The domain of the site this was captured from, kept after that site is gone. |
source_site_id | Uuid | null | Да | The site it came from, or null once that site has been deleted. |
has_screenshot | boolean | Да | 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 | Да | 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… |
deployment_count | integer | Да | How many sites have been built from this blueprint. |
created_at | string | Да | — |
updated_at | string | Да | — |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 404 · 409 · 422 · 429 · 503