hosting
POST /v1/sites/{siteId}/previews
Build a branch as a preview, without touching the live site.
認証
ベアラー トークンとして API キーを送信します。キーには hosting.deploy.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/previews \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "branch": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
A preview NEVER binds the site's hostname: it is reachable at the provider's own per-deployment URL and nowhere else, which is the whole promise of a preview. Previewing the branch the site already serves is refused rather than quietly promoted to a production deploy. Requires `hosting.deploy.manage`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
branch | string | はい | The branch to build as a preview. Must not be the branch the site already serves — that would be a normal deploy. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
target | DeployTarget | はい | Where the site is published from. `fleet` is our own managed fleet; the rest are managed edge hosts, deployed to from a pooled account of ours or the customer's own connected on… |
status | DeployStatus | はい | `idle` means the site has never been deployed. It is reported, never stored — a stored idle would be a second way to say "no deployments" that could contradict the first. |
trigger | DeployTrigger | はい | What caused the deploy. Stored because `requested_by` cannot answer it for a push — the actor there is a webhook delivery, not a person. |
repo | object | はい | — |
branch | object | はい | — |
commit | object | はい | — |
commit_message | object | はい | — |
live_url | object | はい | — |
message | object | はい | Why it failed, else null. Rendered to the customer verbatim. |
requested_by | string | はい | — |
created_at | string | はい | — |
started_at | object | はい | — |
finished_at | object | はい | — |
log | string | はい | The build log, one timestamped line per step. Truncated from the FRONT when long — the end of a build log is where the failure is. |
このエンドポイントが返すエラー
401 · 403 · 404 · 409 · 422 · 429 · 503