hosting
POST /v1/site-blueprints
Capture a built site as a reusable blueprint.
प्रमाणीकरण
एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। कुञ्जीसँग sites.blueprint.manage अनुमति हुनुपर्छ; अनुमति नभएको कुञ्जीलाई 404 होइन, 403 मार्फत अस्वीकार गरिन्छ।
यो इन्डपोइन्टले कुनै संस्थाको आइडी लिँदैन। तपाईंको कुञ्जीले यस अन्तर्गत पर्ने संस्थालाई पहिल्यै पहिचान गर्छ, र प्रतिक्रिया त्यसैमा सीमित हुन्छ।
प्रयास गर्नुहोस्
कोणीय कोष्ठकभित्र भएका जुनसुकै कुरालाई आफ्नो मानहरूद्वारा बदल्नुहोस्, र मुख्य स्थानहोल्डरलाई तपाईंको ड्यासबोर्डको कुञ्जीद्वारा बदल्नुहोस्।
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 कन्सोलले तपाईंको वास्तविक संस्थाको आईडी र आफ्नै कुञ्जी भरिदिन्छ, र लाइभ API विरुद्ध अनुरोध चलाउँछ ताकि तपाईंले वास्तविक प्रतिक्रिया हेर्न सक्नुहोस्। यो एन्डपोइन्टलाई 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