compute

POST `/v1/panels/connections`

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

אימות

שלחו מפתח API כאסימון נושא (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 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 · 422 · 429

POST /v1/panels/connections