compute
POST /v1/panels/connections
Connect a running Plesk panel so it can be managed from here.
การยืนยันตัวตน
ส่ง API key ในรูปแบบ bearer token คีย์ดังกล่าวต้องมีสิทธิ์ connections.manage หากไม่มีสิทธิ์ ระบบจะปฏิเสธด้วยรหัส 403 แทนที่จะเป็น 404
ปลายทางนี้ไม่ต้องใช้รหัสองค์กร คีย์ของคุณระบุองค์กรที่เป็นเจ้าของอยู่แล้ว และการตอบกลับจะถูกจำกัดขอบเขตไว้เฉพาะองค์กรนั้น
ทดลองใช้เลย
แทนที่สิ่งใดๆ ที่อยู่ภายในวงเล็บแหลมด้วยค่าของคุณเอง และตัวยึดตำแหน่งคีย์ด้วยคีย์จากแดชบอร์ดของคุณ
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.
เนื้อหาคำขอ
| ชื่อ | ประเภท | จำเป็นต้องมี | ลักษณะของสิ่งนี้ |
|---|---|---|---|
host | string | ใช่ | — |
port | integer | ไม่ใช่ | — |
label | string | ไม่ใช่ | — |
licence_id | Uuid | ไม่ใช่ | — |
verify_tls | boolean | ไม่ใช่ | — |
api_key | string | ไม่ใช่ | A Plesk API key. Stored in Vault, never in a row. |
username | string | ไม่ใช่ | — |
password | string | ไม่ใช่ | The administrator's password. Stored in Vault, never in a row. |
การตอบกลับ
| ชื่อ | ประเภท | จำเป็นต้องมี | ลักษณะของสิ่งนี้ |
|---|---|---|---|
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 · 422 · 429