compute
POST /v1/panels/connections/{connectionId}/install-licence
Install a licence we bought onto this panel.
Аутентификация
Отправьте ключ 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_id | string | Да | A licence this organisation holds. |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
host | string | Да | — |
port | integer | Да | — |
panel | string | Да | — |
label | string | Да | — |
licence_id | Uuid | Да | 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[] | Да | ⛔⛔ 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 | Да | — |
panel_hostname | string | Да | The panel's own hostname, which need not be the host we connect to. |
licence_name | string | Да | The edition the panel reports it is licensed for. |
verify_tls | boolean | Да | 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 | Да | ⛔ null means never checked, which is not the same as failed. A client must render the two differently. |
last_error | string | Да | 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