compute

POST `/v1/panels/connections`

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

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението 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, за да можете да видите действителния отговор. Отворете този крайpoint в 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…

Грешки, които този крайpoint може да върне

401 · 403 · 422 · 429

POST /v1/panels/connections