compute

GET `/v1/panels/licences/{licenceId}`

One control-panel licence.

توثيقِ شناخت

ایک بیرر ٹوکن کے طور پر ایک API کی بھیجیں۔ کی کے پاس sites.view اجازت ہونی چاہیے؛ اس کے بغیر کی کو 404 کے بجائے 403 کے ساتھ مسترد کر دیا جاتا ہے۔

یہ اینڈ پوائنٹ کوئی آرگنائزیشن آئی ڈی نہیں لیتا۔ آپ کی کلید پہلے ہی اس آرگنائزیشن کی شناخت کرتی ہے جس سے یہ تعلق رکھتی ہے، اور اس کا جواب اسی کے مطابق محدود ہوتا ہے۔

آزمائیں

کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔

curl -X GET https://api.zinndigital.com/v1/panels/licences/{licenceId} \
  -H "Authorization: Bearer zdk_live_…"

لاگ ان ہیں؟ آپ کے ڈیش بورڈ میں موجود API کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو API پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو API کنسول میں کھولیں

تفصیلات

Requires `sites.view`.

پیرامیٹرز

نام	قسم	لازمی	یہ کیا ہے
`licenceId (path)`	`Uuid`	ہاں	The licence's id, as `listPanelLicences` reports it. Ours (UUIDv7).

جواب

نام	قسم	لازمی	یہ کیا ہے
`id`	`Uuid`	ہاں	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`product_code`	`string`	ہاں	The `PanelProduct.code` this licence is for.
`state`	`string<pending, active, suspended, released, failed>`	ہاں	⛔ `suspended` is not a synonym for released. The charge has stopped and the record has not: the licence returns automatically when the account is back in good standing, with…
`target_kind`	`string<ours, customer>`	ہاں	Whose machine this licence runs on. ⛔ Stored rather than derived from whether `server_id` is set: "did we build this machine" and "whose problem is it when the disk fills" a…
`server_id`	`Uuid`	ہاں	Our machine, when there is one. Null for a customer-owned server.
`bound_ip`	`string`	ہاں	The address the licence is registered against at the supplier. ⛔ This is what releasing needs — by teardown the machine may be gone, and a licence we cannot release bills monthl…
`key_number`	`string`	ہاں	The panel-facing key number (`PLSK.01234567`) — an identifier, not a secret. ⛔ The activation code itself is never returned by this API; it lives in Vault.
`price_minor`	`integer`	ہاں	What the customer is charged per month, in minor units, frozen at purchase. A copy rather than a join, so an operator repricing the catalogue cannot move an existing customer's…
`currency`	`string`	ہاں	—
`message`	`string`	ہاں	Why it failed or was suspended, in a sentence the customer reads.
`activated_at`	`string`	ہاں	—

وہ خرابیان جو یہ اینڈ پوائنٹ واپس کر سکتا ہے

401 · 403 · 404 · 429

GET /v1/panels/licences/{licenceId}