hosting

GET /v1/site-blueprints/{siteBlueprintId}

Read one site blueprint.

Minden hosting végpont

Az összes fejlesztői dokumentáció

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) sites.view jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

Requires sites.view.

Paraméterek

NévTípusKötelezőMi ez
siteBlueprintId (path)UuidIgenA 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…

Válasz

NévTípusKötelezőMi ez
idUuidIgenUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringIgen
notesstringIgenThe customer's own note, so they can tell their templates apart.
statusSiteBlueprintStatusIgenWhere 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…
messagestringNemWhy a capture failed, in human English. Empty otherwise. Rendered to the customer verbatim.
stack_typeStackTypeIgenThe 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…
runtimeRuntimeIgenThe runtime the web server serves the site with. node, python and ruby are long-lived application processes on our own servers (docs/715).
product_linestringIgenThe 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_domainstringIgenThe domain of the site this was captured from, kept after that site is gone.
source_site_idUuid | nullIgenThe site it came from, or null once that site has been deleted.
has_screenshotbooleanIgenWhether 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…
deployablebooleanIgenWhether 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_countintegerIgenHow many sites have been built from this blueprint.
created_atstringIgen
updated_atstringIgen

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 429