hosting
GET /v1/sites/{siteId}/build-env
The build variable NAMES a site holds — never their values.
認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/build-env \
-H "Authorization: Bearer zdk_live_…"ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
A build variable is routinely an API key, so there is deliberately no endpoint anywhere in this API that reads one back. This returns the names, which is what a customer needs to see what is set and replace or remove it. The values live in Vault, per site. Requires `sites.view`. A site that has never had variables answers `200` with an empty list — that is not an error. A secret store that cannot be READ answers `503`: the two are deliberately distinguishable, because a store we cannot reach reported as "no variables" is a build that silently ships without its keys.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
names | string[] | はい | The variable names this site holds, sorted. |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429 · 503