compute

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

Install a licence we bought onto this panel.

Всички крайни точки в compute

Всички документи за разработчици

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението 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, за да можете да видите действителния отговор. Отворете този крайpoint в 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…

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 429 · 503