compute

POST `/v1/panels/connections`

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

Wszystkie dokumentacje dla programistów →

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie connections.manage; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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.

Treść żądania

Nazwa	Typ	Wymagane	Co to jest
`host`	`string`	Tak	—
`port`	`integer`	Nie	—
`label`	`string`	Nie	—
`licence_id`	`Uuid`	Nie	—
`verify_tls`	`boolean`	Nie	—
`api_key`	`string`	Nie	A Plesk API key. Stored in Vault, never in a row.
`username`	`string`	Nie	—
`password`	`string`	Nie	The administrator's password. Stored in Vault, never in a row.

Odpowiedź

Nazwa	Typ	Wymagane	Co to jest
`id`	`Uuid`	Tak	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`host`	`string`	Tak	—
`port`	`integer`	Tak	—
`panel`	`string`	Tak	—
`label`	`string`	Tak	—
`licence_id`	`Uuid`	Tak	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[]`	Tak	⛔⛔ 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`	Tak	—
`panel_hostname`	`string`	Tak	The panel's own hostname, which need not be the host we connect to.
`licence_name`	`string`	Tak	The edition the panel reports it is licensed for.
`verify_tls`	`boolean`	Tak	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`	Tak	⛔ `null` means never checked, which is not the same as failed. A client must render the two differently.
`last_error`	`string`	Tak	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…

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 422 · 429

POST /v1/panels/connections