hosting

PATCH `/v1/site-blueprints/{siteBlueprintId}`

Rename a blueprint, or edit its notes.

Autenticación

Envía una clave de API como token de portador. La clave debe tener el permiso sites.blueprint.manage; una clave que no lo tenga se rechazará con un código 403, no 404.

Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.

Pruébalo

Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.

curl -X PATCH https://api.zinndigital.com/v1/site-blueprints/{siteBlueprintId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API

Detalles

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`.

Parámetros

Nombre	Tipo	Obligatorio	¿Qué es esto?
`siteBlueprintId (path)`	`Uuid`	Sí	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…

Cuerpo de la solicitud

Nombre	Tipo	Obligatorio	¿Qué es esto?
`name`	`string`	No	—
`notes`	`string`	No	—

Respuesta

Nombre	Tipo	Obligatorio	¿Qué es esto?
`id`	`Uuid`	Sí	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Sí	—
`notes`	`string`	Sí	The customer's own note, so they can tell their templates apart.
`status`	`SiteBlueprintStatus`	Sí	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`	Sí	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`	Sí	The runtime the web server serves the site with.
`product_line`	`string`	Sí	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`	Sí	The domain of the site this was captured from, kept after that site is gone.
`source_site_id`	`Uuid \| null`	Sí	The site it came from, or null once that site has been deleted.
`has_screenshot`	`boolean`	Sí	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`	Sí	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`	Sí	How many sites have been built from this blueprint.
`created_at`	`string`	Sí	—
`updated_at`	`string`	Sí	—

Errores que este endpoint puede devolver

401 · 403 · 404 · 422 · 429

PATCH /v1/site-blueprints/{siteBlueprintId}