compute

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

Install a licence we bought onto this panel.

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão connections.manage; uma chave sem ela é recusada com 403, e não 404.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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

Parâmetros

Nome	Tipo	Obrigatório	O que é
`connectionId (path)`	`Uuid`	Sim	The connected panel's id, as `listPanelConnections` reports it.

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`licence_id`	`string`	Sim	A licence this organisation holds.

Resposta

Nome	Tipo	Obrigatório	O que é
`id`	`Uuid`	Sim	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`host`	`string`	Sim	—
`port`	`integer`	Sim	—
`panel`	`string`	Sim	—
`label`	`string`	Sim	—
`licence_id`	`Uuid`	Sim	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[]`	Sim	⛔⛔ 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 lic…
`panel_version`	`string`	Sim	—
`panel_hostname`	`string`	Sim	The panel's own hostname, which need not be the host we connect to.
`licence_name`	`string`	Sim	The edition the panel reports it is licensed for.
`verify_tls`	`boolean`	Sim	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 ins…
`checked_at`	`string`	Sim	⛔ `null` means never checked, which is not the same as failed. A client must render the two differently.
`last_error`	`string`	Sim	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 pla…

Erros que este endpoint pode retornar

401 · 403 · 404 · 429 · 503

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