hosting
GET /v1/sites/{siteId}/deployments/{deploymentId}/build-log
The hosting provider's own build log for one deploy.
認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/deployments/{deploymentId}/build-log \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Distinct from the `log` on `GET /deployments/{deploymentId}`, which is the platform's own five steps and is the same five whether a build succeeded or failed. When a build fails this is the only text that says WHY. Tail it with `after` while `complete` is false; `after` is a line offset so a live tail is incremental rather than re-fetching a growing log. A provider that publishes no build log, or a deploy that rebuilt nothing, returns `UNPROCESSABLE_ENTITY` with the reason — never an empty log, which would read as "your build printed nothing". Requires `sites.view`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
deploymentId (path) | Uuid | はい | Deployment ID (UUIDv7). |
after (query) | integer | いいえ | Skip this many lines — the count already rendered. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
lines | BuildLogLine[] | はい | — |
complete | boolean | はい | Whether the build has finished producing lines. Read from the deployment's terminal state, never from "no new lines this time" — a stalled build and a finished one produce the s… |
total | integer | はい | Lines the provider says exist, or `-1` where it publishes no total. Never `0` for unknown, which would read as an empty log. |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429