hosting

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

Rename a blueprint, or edit its notes.

Kimlik Doğrulama

Bearer token olarak bir API anahtarı gönderin. Anahtar sites.blueprint.manage iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.

Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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

Parametreler

Ad	Tür	Zorunlu	Ne olduğu
`siteBlueprintId (path)`	`Uuid`	Evet	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…

İstek gövdesi

Ad	Tür	Zorunlu	Ne olduğu
`name`	`string`	Hayır	—
`notes`	`string`	Hayır	—

Yanıt

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

Bu uç noktanın dönderebileceği hatalar

401 · 403 · 404 · 422 · 429

PATCH /v1/site-blueprints/{siteBlueprintId}