認証
ベアラー トークンとして API キーを送信します。キーには hosting.deploy.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/deploy \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Starts a durable deploy workflow and returns immediately with the new in-flight state. The target is derived from the site's stack and its connected accounts; there is no target to choose. A site with a deploy already running returns `DEPLOY_IN_PROGRESS`, and one with no usable target returns `DEPLOY_TARGET_UNAVAILABLE`. Requires `hosting.deploy.manage`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
Idempotency-Key (header) | string | いいえ | Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
site_id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
target | DeployTarget | null | はい | Null when no target can be derived yet. |
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. |
last_deployed_at | object | はい | When the site last went live, or null if it never has. Null means nothing to show — never zero and never an epoch date. |
live_url | object | はい | The served URL once live, always https, else null. A non-HTTPS value is rejected server-side rather than returned. |
repo | object | はい | Source repository for the Pages targets, else null. |
commit | object | はい | The deployed commit ref, else null. |
message | object | はい | Why the last deploy failed, else null. Rendered to the customer verbatim. |
can_deploy | boolean | はい | False while a deploy is in flight or the site cannot be deployed. |
このエンドポイントが返すエラー
401 · 403 · 404 · 409 · 422 · 429 · 503