compute
POST /v1/panels/connections
Connect a running Plesk panel so it can be managed from here.
認証
ベアラー トークンとして API キーを送信します。キーには connections.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/panels/connections \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "host": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
The credential is stored in Vault and **never** in a row. Supply either an API key (preferred — it can be revoked in Plesk without changing the administrator password) or the administrator login and password. ⭐ **The panel is probed before the connection is kept.** A panel that cannot be reached, or whose credential is refused, is rejected while the customer still has their Plesk tab open and can fix it — rather than failing later, when nobody remembers what they typed. ⛔ `422` distinguishes *we could not reach it* from *it refused our credential*. Those send the customer to their firewall and to their password respectively, and merging them makes people change a password that was working. Requires `connections.manage`.
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
host | string | はい | — |
port | integer | いいえ | — |
label | string | いいえ | — |
licence_id | Uuid | いいえ | — |
verify_tls | boolean | いいえ | — |
api_key | string | いいえ | A Plesk API key. Stored in Vault, never in a row. |
username | string | いいえ | — |
password | string | いいえ | The administrator's password. Stored in Vault, never in a row. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
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 lic… |
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 ins… |
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 pla… |
このエンドポイントが返すエラー
401 · 403 · 422 · 429