compute
POST /v1/panels/connections
Connect a running Plesk panel so it can be managed from here.
Autentifikacija
Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu connections.manage; ključ bez nje se odbija s kodom 403, a ne 404.
Ova krajnja točka ne prihvaća ID organizacije. Vaš ključ već identificira organizaciju kojoj pripada, a odgovor je ograničen na nju.
Isprobajte
Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.
curl -X POST https://api.zinndigital.com/v1/panels/connections \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "host": <string> }'Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli
Pojedinosti
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.
Tijelo zahtjeva
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
host | string | Da | — |
port | integer | Ne | — |
label | string | Ne | — |
licence_id | Uuid | Ne | — |
verify_tls | boolean | Ne | — |
api_key | string | Ne | A Plesk API key. Stored in Vault, never in a row. |
username | string | Ne | — |
password | string | Ne | The administrator's password. Stored in Vault, never in a row. |
Odgovor
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
id | Uuid | Da | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
host | string | Da | — |
port | integer | Da | — |
panel | string | Da | — |
label | string | Da | — |
licence_id | Uuid | Da | 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[] | Da | ⛔⛔ 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 | Da | — |
panel_hostname | string | Da | The panel's own hostname, which need not be the host we connect to. |
licence_name | string | Da | The edition the panel reports it is licensed for. |
verify_tls | boolean | Da | 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 | Da | ⛔ null means never checked, which is not the same as failed. A client must render the two differently. |
last_error | string | Da | 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… |
Pogreške koje ova krajnja točka može vratiti
401 · 403 · 422 · 429