hosting
PATCH /v1/site-blueprints/{siteBlueprintId}
Rename a blueprint, or edit its notes.
Authentication
Send an API key as a bearer token. The key must carry the sites.blueprint.manage permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X PATCH https://api.zinndigital.com/v1/site-blueprints/{siteBlueprintId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Both fields are optional and **omitted is not the same as empty**: omitting `notes` leaves the existing note alone, sending `""` clears it. Collapsing the two would make it impossible to clear a note, or would wipe one on every rename. Requires `sites.blueprint.manage`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteBlueprintId (path) | Uuid | Yes | A SITE blueprint's id (UUIDv7) — one of the customer's own captured sites. ⛔ Not a `blueprintId`: that names a published stack recipe, and the two are different resources that u… |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
name | string | No | — |
notes | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Yes | — |
notes | string | Yes | The customer's own note, so they can tell their templates apart. |
status | SiteBlueprintStatus | Yes | 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 | No | Why a capture failed, in human English. Empty otherwise. Rendered to the customer verbatim. |
stack_type | StackType | Yes | 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 | Yes | The runtime the web server serves the site with. |
product_line | string | Yes | 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 | Yes | The domain of the site this was captured from, kept after that site is gone. |
source_site_id | Uuid | null | Yes | The site it came from, or null once that site has been deleted. |
has_screenshot | boolean | Yes | 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 | Yes | 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 | Yes | How many sites have been built from this blueprint. |
created_at | string | Yes | — |
updated_at | string | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429