compute
POST /v1/panels/connections
Connect a running Plesk panel so it can be managed from here.
Autenticación
Envía una clave de API como token de portador. La clave debe tener el permiso connections.manage; una clave que no lo tenga se rechazará con un código 403, no 404.
Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
curl -X POST https://api.zinndigital.com/v1/panels/connections \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "host": <string> }'¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
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`.
Cuerpo de la solicitud
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
host | string | Sí | — |
port | integer | No | — |
label | string | No | — |
licence_id | Uuid | No | — |
verify_tls | boolean | No | — |
api_key | string | No | A Plesk API key. Stored in Vault, never in a row. |
username | string | No | — |
password | string | No | The administrator's password. Stored in Vault, never in a row. |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
id | Uuid | Sí | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
host | string | Sí | — |
port | integer | Sí | — |
panel | string | Sí | — |
label | string | Sí | — |
licence_id | Uuid | Sí | 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[] | Sí | ⛔⛔ **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 | Sí | — |
panel_hostname | string | Sí | The panel's own hostname, which need not be the host we connect to. |
licence_name | string | Sí | The edition the panel reports it is licensed for. |
verify_tls | boolean | Sí | 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 | Sí | ⛔ `null` means **never checked**, which is not the same as *failed*. A client must render the two differently. |
last_error | string | Sí | 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… |
Errores que este endpoint puede devolver
401 · 403 · 422 · 429