compute

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

Install a licence we bought onto this panel.

Všechny koncové body compute

Všechny dokumenty pro vývojáře

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění connections.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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

NázevTypPožadovánoCo to je
connectionId (path)UuidAnoThe connected panel's id, as listPanelConnections reports it.

Tělo požadavku

NázevTypPožadovánoCo to je
licence_idstringAnoA licence this organisation holds.

Odpověď

NázevTypPožadovánoCo to je
idUuidAnoUUIDv7 identifier — sortable by creation time (docs/02 §8).
hoststringAno
portintegerAno
panelstringAno
labelstringAno
licence_idUuidAnoThe 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[]Ano⛔⛔ 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_versionstringAno
panel_hostnamestringAnoThe panel's own hostname, which need not be the host we connect to.
licence_namestringAnoThe edition the panel reports it is licensed for.
verify_tlsbooleanAnoWhether 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_atstringAnonull means never checked, which is not the same as failed. A client must render the two differently.
last_errorstringAnoEmpty 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…

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 429 · 503