hosting
POST /v1/site-blueprints
Capture a built site as a reusable blueprint.
ავტორიზაცია
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 POST https://api.zinndigital.com/v1/site-blueprints \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "site_id": <Uuid>, "name": <string> }'შესული ხართ? თქვენი სამართავ პანელში არსებული API კონსოლი ავტომატურად ამატებს თქვენი რეალური ორგანიზაციის ID-სა და საკუთარ გასაღებს და ატარებს მოთხოვნას ცოცხალ API-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი API კონსოლში
დეტალები
Starts a durable capture — a backup of the named site, plus a screenshot of its home page — and answers 202 with the new row in capturing. Poll the list. Two shapes. Omit backup_id and a new backup is taken, which spends one of the site's three per-rolling-day on-demand slots and is refused with a 429 naming when the next opens. Give backup_id and an existing stored backup is adopted: the blueprint is ready immediately and no allowance is spent, which is what a customer wants when this morning's site is broken and last night's is the template. The site must be active — a template of a half-built or failed site is not a thing anybody means to make — and its hosting must be able to produce a backup at all. Requires sites.blueprint.manage.
პარამეტრები
| სახელი | ტიპი | სავალდებულო | რა არის ეს |
|---|---|---|---|
Idempotency-Key (header) | string | არა | Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats. |
მოთხოვნის სხეული
| სახელი | ტიპი | სავალდებულო | რა არის ეს |
|---|---|---|---|
site_id | Uuid | დიახ | The built site to capture. Must be active. |
name | string | დიახ | — |
notes | string | არა | — |
backup_id | Uuid | null | არა | An existing stored backup of that site to adopt, instead of taking a new one. Adopting spends none of the site's three-per-rolling-day on-demand allowance and makes the… |
პასუხი
| სახელი | ტიპი | სავალდებულო | რა არის ეს |
|---|---|---|---|
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 · 409 · 422 · 429 · 503