compute

POST `/v1/panels/connections`

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

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění connections.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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.

Tělo požadavku

Název	Typ	Požadováno	Co to je
`host`	`string`	Ano	—
`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.

Odpověď

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

Chyby, které může tento koncový bod vrátit

401 · 403 · 422 · 429

POST /v1/panels/connections