hosting

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

Rename a blueprint, or edit its notes.

ავტორიზაცია

API გასაღები გაგზავნეთ როგორც მატარებელი ტოკენი (bearer token). გასაღებს უნდა ჰქონდეს sites.blueprint.manage ნებართვა; ამის გარეშე გასაღები უარყოფილი იქნება 403 და არა 404 სტატუსით.

ეს ბოლო წერტილი არ იღებს ორგანიზაციის იდენტიფიკატორს. თქვენი გასაღები უკვე აიდენტიფიცირებს იმ ორგანიზაციას, რომელსაც ის ეკუთვნის, და პასუხი შემოფარგლულია მისით.

სცადეთ

შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.

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-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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 u…

მოთხოვნის სხეული

სახელი	ტიპი	სავალდებულო	რა არის ეს
`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 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}