hosting
POST /v1/sites/{siteId}/ssh-keys
Authorise a public key for SSH on a site.
認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/ssh-keys \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "handle": <string>, "key": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Files one public key under a handle and returns the key as it was stored. 201 and the created key rather than the whole list, because the list is re-read anyway: can_create is a property of the collection and the vendor's own key count moves with it. ⛔ What makes a key valid is checked in the service, not in this schema, and the sentence the customer reads is the same whichever door they came through — including the one that says "that is your private key". A line that is not a public key we accept, a handle outside [A-Za-z0-9][A-Za-z0-9._-]{0,63}, a duplicate handle, or a package type that does not include SSH are all 422 with our wording, before the vendor is called. 404 for a site with no vendor hosting package, or one that is not the caller's. Requires sites.view and sites.panel_access — this write grants a shell.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
handle | string | はい | What to file the key under. Constrained to [A-Za-z0-9][A-Za-z0-9._-]{0,63}; anything else is refused with our wording rather than the vendor's. |
key | string | はい | The public key line, as OpenSSH writes it. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
handle | string | はい | The name the key is filed under, ours and the vendor's, and what deleteSiteSshKey addresses. Constrained to [A-Za-z0-9][A-Za-z0-9._-]{0,63}. |
key | string | はい | The public key line, in full and never truncated. It is a public key — publishing it is what it is for — and a shortened one would stop a customer confirming that the key on… |
algorithm | string | はい | The key type parsed out of the line. "" when the stored line does not parse as one of the algorithms we accept, which is possible for a key added at the vendor before this… |
comment | string | はい | The trailing comment on the key line. Often an email address, often empty. |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429 · 503