compute

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

Install a licence we bought onto this panel.

Усі кінцеві точки compute

Уся документація для розробників

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл connections.manage; ключ без нього відхиляється з кодом 403, а не 404.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

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> }'

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

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

Параметри

НазваТипОбов'язковеЩо це таке
connectionId (path)UuidТакThe connected panel's id, as listPanelConnections reports it.

Тіло запиту

НазваТипОбов'язковеЩо це таке
licence_idstringТакA licence this organisation holds.

Відповідь

НазваТипОбов'язковеЩо це таке
idUuidТакUUIDv7 identifier — sortable by creation time (docs/02 §8).
hoststringТак
portintegerТак
panelstringТак
labelstringТак
licence_idUuidТак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_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…
panel_versionstringТак
panel_hostnamestringТакThe panel's own hostname, which need not be the host we connect to.
licence_namestringТакThe edition the panel reports it is licensed for.
verify_tlsbooleanТак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_atstringТакnull means never checked, which is not the same as failed. A client must render the two differently.
last_errorstringТак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…

Помилки, які може повертати ця кінцева точка

401 · 403 · 404 · 429 · 503