hosting

GET /v1/site-blueprints/{siteBlueprintId}

Read one site blueprint.

Alle hosting Endpunkte

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung sites.view verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.

Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

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

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

Requires `sites.view`.

Parameter

NameTypErforderlichWas es ist
siteBlueprintId (path)UuidJaA 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…

Antwort

NameTypErforderlichWas es ist
idUuidJaUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringJa
notesstringJaThe customer's own note, so they can tell their templates apart.
statusSiteBlueprintStatusJaWhere 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…
messagestringNeinWhy a capture failed, in human English. Empty otherwise. Rendered to the customer verbatim.
stack_typeStackTypeJaThe 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…
runtimeRuntimeJaThe runtime the web server serves the site with.
product_linestringJaThe 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_domainstringJaThe domain of the site this was captured from, kept after that site is gone.
source_site_idUuid | nullJaThe site it came from, or null once that site has been deleted.
has_screenshotbooleanJaWhether 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…
deployablebooleanJaWhether 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_countintegerJaHow many sites have been built from this blueprint.
created_atstringJa
updated_atstringJa

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 429