compute
POST /v1/panels/connections
Connect a running Plesk panel so it can be managed from here.
Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation connections.manage ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X POST https://api.zinndigital.com/v1/panels/connections \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "host": <string> }'Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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.
Corps de la requête
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
host | string | Oui | — |
port | integer | Non | — |
label | string | Non | — |
licence_id | Uuid | Non | — |
verify_tls | boolean | Non | — |
api_key | string | Non | A Plesk API key. Stored in Vault, never in a row. |
username | string | Non | — |
password | string | Non | The administrator's password. Stored in Vault, never in a row. |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
id | Uuid | Oui | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
host | string | Oui | — |
port | integer | Oui | — |
panel | string | Oui | — |
label | string | Oui | — |
licence_id | Uuid | Oui | 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[] | Oui | ⛔⛔ 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 | Oui | — |
panel_hostname | string | Oui | The panel's own hostname, which need not be the host we connect to. |
licence_name | string | Oui | The edition the panel reports it is licensed for. |
verify_tls | boolean | Oui | 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 | Oui | ⛔ null means never checked, which is not the same as failed. A client must render the two differently. |
last_error | string | Oui | 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… |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 422 · 429