compute
POST /v1/panels/connections/{connectionId}/install-licence
Install a licence we bought onto this panel.
認証
ベアラー トークンとして API キーを送信します。キーには connections.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/panels/connections/{connectionId}/install-licence \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "licence_id": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
⛔⛔ Buying a licence and installing it are different acts, and doing only the first is a recurring charge for nothing. This is the step that makes a purchase useful. ⭐ The panel is read back afterwards rather than the call being trusted, so the response states what the panel now actually holds. Requires connections.manage.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
connectionId (path) | Uuid | はい | The connected panel's id, as listPanelConnections reports it. |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
licence_id | string | はい | A licence this organisation holds. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
host | string | はい | — |
port | integer | はい | — |
panel | string | はい | — |
label | string | はい | — |
licence_id | Uuid | はい | The licence this panel runs on, where we sold it. Null is a supported case, not an error: a customer may connect a panel they licensed elsewhere. |
proved_capabilities | string[] | はい | ⛔⛔ What this CONNECTION demonstrated, not what the adapter can express. A Plesk box can answer every read and refuse /cli/*/call outright, and both one-click login and… |
panel_version | string | はい | — |
panel_hostname | string | はい | The panel's own hostname, which need not be the host we connect to. |
licence_name | string | はい | The edition the panel reports it is licensed for. |
verify_tls | boolean | はい | Whether we verify the panel's TLS certificate. Per connection, because many Plesk boxes present a self-signed certificate on 8443 — the panel's own default before a customer… |
checked_at | string | はい | ⛔ null means never checked, which is not the same as failed. A client must render the two differently. |
last_error | string | はい | Empty when the last check succeeded. Otherwise the reason, which distinguishes we could not reach it from it refused our credential — the two send a customer to opposite… |
このエンドポイントが返すエラー
401 · 403 · 404 · 429 · 503