compute

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

Install a licence we bought onto this panel.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن 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

التفاصيل

⛔⛔ **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_id`	`string`	نعم	A licence this organisation holds.

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`id`	`Uuid`	نعم	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`host`	`string`	نعم	—
`port`	`integer`	نعم	—
`panel`	`string`	نعم	—
`label`	`string`	نعم	—
`licence_id`	`Uuid`	نعم	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[]`	نعم	⛔⛔ 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`	نعم	—
`panel_hostname`	`string`	نعم	The panel's own hostname, which need not be the host we connect to.
`licence_name`	`string`	نعم	The edition the panel reports it is licensed for.
`verify_tls`	`boolean`	نعم	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`	نعم	⛔ `null` means never checked, which is not the same as failed. A client must render the two differently.
`last_error`	`string`	نعم	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…

الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه

401 · 403 · 404 · 429 · 503

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