hosting

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

Rename a blueprint, or edit its notes.

प्रमाणन

बेरर टोकन के रूप में एक API कुंजी भेजें। कुंजी के पास 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.

पैरामीटर

नाम	प्रकार	आवश्यक	यह क्या है
`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. `node`, `python` and `ruby` are long-lived application processes on our own servers (docs/715).
`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}