compute
POST /v1/panels/connections/{connectionId}/install-licence
Install a licence we bought onto this panel.
Xác thực
Gửi khóa API dưới dạng mã thông báo bearer. Khóa này phải có quyền connections.manage; khóa không có quyền này sẽ bị từ chối với mã lỗi 403, không phải 404.
Endpoint này không nhận ID tổ chức. Khóa của bạn đã xác định tổ chức mà nó thuộc về và phản hồi được giới hạn trong phạm vi đó.
Dùng thử
Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.
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> }'Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API
Chi tiết
⛔⛔ **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`.
Tham số
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
connectionId (path) | Uuid | Có | The connected panel's id, as `listPanelConnections` reports it. |
Nội dung yêu cầu
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
licence_id | string | Có | A licence this organisation holds. |
Phản hồi
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
id | Uuid | Có | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
host | string | Có | — |
port | integer | Có | — |
panel | string | Có | — |
label | string | Có | — |
licence_id | Uuid | Có | 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[] | Có | ⛔⛔ **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 | Có | — |
panel_hostname | string | Có | The panel's own hostname, which need not be the host we connect to. |
licence_name | string | Có | The edition the panel reports it is licensed for. |
verify_tls | boolean | Có | 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 | Có | ⛔ `null` means **never checked**, which is not the same as *failed*. A client must render the two differently. |
last_error | string | Có | 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… |
Các lỗi điểm cuối này có thể trả về
401 · 403 · 404 · 429 · 503