hosting

GET /v1/site-blueprints/{siteBlueprintId}

Read one site blueprint.

כל נקודות הקצה מסוג hosting

אימות

שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה sites.view; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.

נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

curl -X GET https://api.zinndigital.com/v1/site-blueprints/{siteBlueprintId} \
  -H "Authorization: Bearer zdk_live_…"

מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API

פרטים

Requires `sites.view`.

פרמטרים

שםסוגנדרשמה זה
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…

תשובה

שםסוגנדרשמה זה
idUuidכןUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringכן
notesstringכןThe customer's own note, so they can tell their templates apart.
statusSiteBlueprintStatusכן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…
messagestringלאWhy a capture failed, in human English. Empty otherwise. Rendered to the customer verbatim.
stack_typeStackTypeכן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…
runtimeRuntimeכןThe runtime the web server serves the site with.
product_linestringכן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_domainstringכןThe domain of the site this was captured from, kept after that site is gone.
source_site_idUuid | nullכןThe site it came from, or null once that site has been deleted.
has_screenshotbooleanכן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…
deployablebooleanכן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_countintegerכןHow many sites have been built from this blueprint.
created_atstringכן
updated_atstringכן

שגיאות שנקודה קצה זו עשויה להחזיר

401 · 403 · 404 · 429