hosting

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

Rename a blueprint, or edit its notes.

Autentificare

Trimiteți o cheie API ca token de tip bearer. Cheia trebuie să aibă permisiunea sites.blueprint.manage; o cheie care nu o are va fi respinsă cu 403, nu 404.

Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.

Încearcă

Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.

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

Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API

Detalii

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

Parametri

Nume	Tip	Obligatoriu	Ce este
`siteBlueprintId (path)`	`Uuid`	Da	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…

Corp cerere

Nume	Tip	Obligatoriu	Ce este
`name`	`string`	Nu	—
`notes`	`string`	Nu	—

Răspuns

Nume	Tip	Obligatoriu	Ce este
`id`	`Uuid`	Da	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Da	—
`notes`	`string`	Da	The customer's own note, so they can tell their templates apart.
`status`	`SiteBlueprintStatus`	Da	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`	Nu	Why a capture failed, in human English. Empty otherwise. Rendered to the customer verbatim.
`stack_type`	`StackType`	Da	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`	Da	The runtime the web server serves the site with.
`product_line`	`string`	Da	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`	Da	The domain of the site this was captured from, kept after that site is gone.
`source_site_id`	`Uuid \| null`	Da	The site it came from, or null once that site has been deleted.
`has_screenshot`	`boolean`	Da	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`	Da	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`	Da	How many sites have been built from this blueprint.
`created_at`	`string`	Da	—
`updated_at`	`string`	Da	—

Erori pe care le poate returna acest punct final

401 · 403 · 404 · 422 · 429

PATCH /v1/site-blueprints/{siteBlueprintId}