compute
POST /v1/panels/connections/{connectionId}/check
Re-probe what this panel can actually do.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز connections.manage باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X POST https://api.zinndigital.com/v1/panels/connections/{connectionId}/check \
-H "Authorization: Bearer zdk_live_…"وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
⛔⛔ Rewrites provedCapabilities from what the panel DEMONSTRATED, never from what the adapter can express. A Plesk box can answer every read perfectly and refuse /cli/*/call outright, because the command-line gateway is separately licensed and separately permissioned — and both one-click login and licence installation go through it. Re-probing matters because the answer changes without telling us: the customer's own administrator can restrict it, or the licence can lapse. ⛔ A failed check CLEARS provedCapabilities rather than keeping yesterday's list, so the screen stops offering buttons against a panel we can no longer reach. Requires connections.manage.
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
connectionId (path) | Uuid | بله | The connected panel's id, as listPanelConnections reports it. |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
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… |
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… |
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… |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 403 · 404 · 429