compute

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

Install a licence we bought onto this panel.

Tous les points de terminaison compute

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

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

Paramètres

NomTypeObligatoireQu'est-ce que c'est
connectionId (path)UuidOuiThe connected panel's id, as `listPanelConnections` reports it.

Corps de la requête

NomTypeObligatoireQu'est-ce que c'est
licence_idstringOuiA licence this organisation holds.

Réponse

NomTypeObligatoireQu'est-ce que c'est
idUuidOuiUUIDv7 identifier — sortable by creation time (docs/02 §8).
hoststringOui
portintegerOui
panelstringOui
labelstringOui
licence_idUuidOuiThe 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[]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 lic…
panel_versionstringOui
panel_hostnamestringOuiThe panel's own hostname, which need not be the host we connect to.
licence_namestringOuiThe edition the panel reports it is licensed for.
verify_tlsbooleanOuiWhether 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_atstringOui⛔ `null` means **never checked**, which is not the same as *failed*. A client must render the two differently.
last_errorstringOuiEmpty 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…

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404 · 429 · 503