compute

POST `/v1/panels/connections`

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

Autentificare

Trimiteți o cheie API ca token de tip bearer. Cheia trebuie să aibă permisiunea connections.manage; o cheie care nu o are va fi respinsă cu 403, nu 404.

Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.

Încearcă

Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.

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

Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API

Detalii

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`.

Corp cerere

Nume	Tip	Obligatoriu	Ce este
`host`	`string`	Da	—
`port`	`integer`	Nu	—
`label`	`string`	Nu	—
`licence_id`	`Uuid`	Nu	—
`verify_tls`	`boolean`	Nu	—
`api_key`	`string`	Nu	A Plesk API key. Stored in Vault, never in a row.
`username`	`string`	Nu	—
`password`	`string`	Nu	The administrator's password. Stored in Vault, never in a row.

Răspuns

Nume	Tip	Obligatoriu	Ce este
`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 lic…
`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 ins…
`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 pla…

Erori pe care le poate returna acest punct final

401 · 403 · 422 · 429

POST /v1/panels/connections