compute

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

Install a licence we bought onto this panel.

Wszystkie punkty końcowe compute

Wszystkie dokumentacje dla programistów

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie connections.manage; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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

Parametry

NazwaTypWymaganeCo to jest
connectionId (path)UuidTakThe connected panel's id, as listPanelConnections reports it.

Treść żądania

NazwaTypWymaganeCo to jest
licence_idstringTakA licence this organisation holds.

Odpowiedź

NazwaTypWymaganeCo to jest
idUuidTakUUIDv7 identifier — sortable by creation time (docs/02 §8).
hoststringTak
portintegerTak
panelstringTak
labelstringTak
licence_idUuidTakThe 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[]Tak⛔⛔ 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_versionstringTak
panel_hostnamestringTakThe panel's own hostname, which need not be the host we connect to.
licence_namestringTakThe edition the panel reports it is licensed for.
verify_tlsbooleanTakWhether 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_atstringTaknull means never checked, which is not the same as failed. A client must render the two differently.
last_errorstringTakEmpty 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…

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 429 · 503