compute

POST /v1/panels/connections

Connect a running Plesk panel so it can be managed from here.

تمام compute اینڈ پوائنٹس

توثيقِ شناخت

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

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

آزمائیں

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

curl -X POST https://api.zinndigital.com/v1/panels/connections \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "host": <string> }'

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

تفصیلات

The credential is stored in Vault and **never** in a row. Supply either an API key (preferred — it can be revoked in Plesk without changing the administrator password) or the administrator login and password. ⭐ **The panel is probed before the connection is kept.** A panel that cannot be reached, or whose credential is refused, is rejected while the customer still has their Plesk tab open and can fix it — rather than failing later, when nobody remembers what they typed. ⛔ `422` distinguishes *we could not reach it* from *it refused our credential*. Those send the customer to their firewall and to their password respectively, and merging them makes people change a password that was working. Requires `connections.manage`.

درخواست کا باڈی

نامقسملازمییہ کیا ہے
hoststringہاں
portintegerنہیں
labelstringنہیں
licence_idUuidنہیں
verify_tlsbooleanنہیں
api_keystringنہیںA Plesk API key. Stored in Vault, never in a row.
usernamestringنہیں
passwordstringنہیںThe administrator's password. Stored in Vault, never in a row.

جواب

نامقسملازمییہ کیا ہے
idUuidہاںUUIDv7 identifier — sortable by creation time (docs/02 §8).
hoststringہاں
portintegerہاں
panelstringہاں
labelstringہاں
licence_idUuidہاں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_capabilitiesstring[]ہاں⛔⛔ **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_versionstringہاں
panel_hostnamestringہاںThe panel's own hostname, which need not be the host we connect to.
licence_namestringہاںThe edition the panel reports it is licensed for.
verify_tlsbooleanہاں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_atstringہاں⛔ `null` means **never checked**, which is not the same as *failed*. A client must render the two differently.
last_errorstringہاں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 · 422 · 429