hosting

GET /v1/site-blueprints/{siteBlueprintId}

Read one site blueprint.

すべての hosting エンドポイント

認証

ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

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

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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