hosting
POST /v1/site-blueprints
Capture a built site as a reusable blueprint.
المصادقة
أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن sites.blueprint.manage؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.
لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.
جربه الآن
استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.
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
التفاصيل
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