hosting

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

Rename a blueprint, or edit its notes.

Аутентификация

API кілтін bearer токені ретінде жіберіңіз. Кілтте sites.blueprint.manage рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.

Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.

Әрекет етіп көру

Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.

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

Жүйеге кіргенсіз бе? Бақылау тақтасындағы API консолі ұйымыңыздың нақты идентификаторы мен жеке кілтіңізді автоматты түрде толтырады да, нақты жауапты көре алуыңыз үшін сұрауды тікелей жұмыс істеп тұрған API арқылы орындайды. Бұл соңғы нүктені API консолінде ашыңыз

Мәліметтер

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

Параметрлер

Аты	Tүрі	Міндетті	Мазмұны
`siteBlueprintId (path)`	`Uuid`	Иә	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…

Сұрау денесі

Аты	Tүрі	Міндетті	Мазмұны
`name`	`string`	Жоқ	—
`notes`	`string`	Жоқ	—

Жауап

Аты	Tүрі	Міндетті	Мазмұны
`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 rea…
`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…
`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 wh…
`deployment_count`	`integer`	Иә	How many sites have been built from this blueprint.
`created_at`	`string`	Иә	—
`updated_at`	`string`	Иә	—

Бұл соңғы нүкте қайтара алатын қателер

401 · 403 · 404 · 422 · 429

PATCH /v1/site-blueprints/{siteBlueprintId}