compute
POST /v1/panels/connections
Connect a running Plesk panel so it can be managed from here.
Doğrulama
API açarını bearer token kimi göndərin. Açar connections.manage icazəsinə malik olmalıdır; bu icazəsi olmayan açar 404 deyil, 403 xətası ilə rədd edilir.
Bu endpoint heç bir təşkilat ID-si tələb etmir. Sizin açarınız artıq aid olduğu təşkilatı müəyyən edir və cavab həmin təşkilat üçün məhdudlaşdırılır.
Sınaqdan keçir
Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.
curl -X POST https://api.zinndigital.com/v1/panels/connections \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "host": <string> }'Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın
Təfərrüatlar
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`.
Sorğu gövdəsi
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
host | string | Bəli | — |
port | integer | Xeyr | — |
label | string | Xeyr | — |
licence_id | Uuid | Xeyr | — |
verify_tls | boolean | Xeyr | — |
api_key | string | Xeyr | A Plesk API key. Stored in Vault, never in a row. |
username | string | Xeyr | — |
password | string | Xeyr | The administrator's password. Stored in Vault, never in a row. |
Cavab
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
id | Uuid | Bəli | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
host | string | Bəli | — |
port | integer | Bəli | — |
panel | string | Bəli | — |
label | string | Bəli | — |
licence_id | Uuid | Bəli | 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[] | Bəli | ⛔⛔ **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 | Bəli | — |
panel_hostname | string | Bəli | The panel's own hostname, which need not be the host we connect to. |
licence_name | string | Bəli | The edition the panel reports it is licensed for. |
verify_tls | boolean | Bəli | 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 | Bəli | ⛔ `null` means **never checked**, which is not the same as *failed*. A client must render the two differently. |
last_error | string | Bəli | 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… |
Bu son nöqtənin qaytara biləcəyi xətalar
401 · 403 · 422 · 429