hosting
GET /v1/sites/{siteId}/ssh-keys
List a site's authorised SSH keys.
認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/ssh-keys \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Every public key that can open a shell on the site's hosting package, together with whether the package restricts SSH to a list of addresses. ssh has been rendered as an included plan feature since the Hosting tab shipped — from a vendor flag that really is true on both package types we sell — with no way anywhere in the product to upload a key, so until this resource existed the entitlement was sold and read by nothing. ⛔ ip_restricted is its own field and must never be derived from ip_allowlist == []. The vendor answers "no restriction" as null, and an empty list rendered as a restriction would tell the customer they are protected when the truth is the opposite. ip_allowlist_editable is false today for a vendor reason rather than a plan one, so a client renders the list read-only instead of an editor that cannot save. A site that is not on a vendor hosting package has no such resource and returns 404, exactly as an out-of-scope or unknown id does — never a 403, never an existence oracle. Requires sites.view and sites.panel_access: the list is the access-control state of a shell on the customer's server, which is strictly more than the phpMyAdmin and file-manager access that key already names.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
permitted | boolean | はい | Whether the package type includes SSH at all. This is the flag behind "your plan does not include this". |
can_create | boolean | はい | permitted, and the package has room for another key. Two fields rather than one because those are different sentences, and a single flag makes the screen say the wrong one. |
keys | SiteSshKey[] | はい | The keys currently authorised on the package. |
ip_allowlist | string[] | はい | The addresses SSH is restricted to, when it is restricted. |
ip_restricted | boolean | はい | Whether an address restriction is actually in force. ⛔ Distinct from ip_allowlist == [] and never derived from it. The vendor answers "no restriction" as null, and an empty… |
ip_allowlist_editable | boolean | はい | Whether the allow-list can be written. False today for a vendor reason rather than a plan one, so a client renders the list read-only instead of an editor that cannot save. |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429 · 503