hosting

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

Rename a blueprint, or edit its notes.

Նույնականացում

Ուղարկեք API բանալին որպես bearer token: Բանալին պետք է ունենա sites.blueprint.manage թույլտվությունը. առանց դրա բանալին մերժվում է 403, և ոչ թե 404 կարգավիճակով:

Այս վերջնակետը կազմակերպության ID չի ընդունում: Ձեր բանալին արդեն իսկ նույնականացնում է այն կազմակերպությունը, որին պատկանում է, և պատասխանը սահմանափակված է դրանով:

Փորձել

Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:

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

Մուտք գործե՞լ եք: Ձեր վահանակի API վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ 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.

Պարամետրեր

Անուն	Տեսակ	Պահանջվում է	Ինչ է դա
`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…

Հարցման մարմին

Անուն	Տեսակ	Պահանջվում է	Ինչ է դա
`name`	`string`	Ոչ	—
`notes`	`string`	Ոչ	—

Պատասխան

Անուն	Տեսակ	Պահանջվում է	Ինչ է դա
`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 read…
`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 a…
`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…
`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}