hosting
DELETE /v1/sites/{siteId}/ssh-keys/{handle}
Withdraw an authorised SSH key from a site.
認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X DELETE https://api.zinndigital.com/v1/sites/{siteId}/ssh-keys/{handle} \
-H "Authorization: Bearer zdk_live_…"ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Removes the key from the package's authorised list. Whatever was signing in with it stops immediately, which is the point — a laptop that was lost is a key that has to stop working now rather than at the next deploy. `204` and no body: the client re-reads the list, because `can_create` and the vendor's key count both move with the removal and neither can be derived from the response to a delete. `404` for a site with no vendor hosting package, one that is not the caller's, or a handle that is not on it — the delete URL must not become a way to enumerate what exists elsewhere. Requires `sites.view` **and** `sites.panel_access`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
handle (path) | string | はい | The handle the key is filed under, exactly as `getSiteSshAccess` reports it. Constrained to `[A-Za-z0-9][A-Za-z0-9._-]{0,63}`, so it never contains a slash — but it is the custo… |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429 · 503