compute

POST /v1/panels/connections/{connectionId}/install-licence

Install a licence we bought onto this panel.

Todos los endpoints de compute

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/{connectionId}/install-licence \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "licence_id": <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

⛔⛔ **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`.

Parámetros

NombreTipoObligatorio¿Qué es esto?
connectionId (path)UuidThe connected panel's id, as `listPanelConnections` reports it.

Cuerpo de la solicitud

NombreTipoObligatorio¿Qué es esto?
licence_idstringA licence this organisation holds.

Respuesta

NombreTipoObligatorio¿Qué es esto?
idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
hoststring
portinteger
panelstring
labelstring
licence_idUuidThe 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_capabilitiesstring[]⛔⛔ **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_versionstring
panel_hostnamestringThe panel's own hostname, which need not be the host we connect to.
licence_namestringThe edition the panel reports it is licensed for.
verify_tlsbooleanWhether 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_atstring⛔ `null` means **never checked**, which is not the same as *failed*. A client must render the two differently.
last_errorstringEmpty 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 · 404 · 429 · 503