compute

POST `/v1/panels/connections`

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

Tabbatar da Asali

Aika maɓallin API azaman alamar ɗauka (bearer token). Dole ne maɓallin ya kasance yana da izinin connections.manage; idan babu shi, za a ƙi amfani da maɓallin tare da lambar 403, ba 404 ba.

Wannan wurin ƙarewa ba ya buƙatar ID na ƙungiya. Maɓallin ku ya riga ya gano ƙungiyar da yake ciki, kuma an iyakance amsa a kanta.

Gwada

May gurbin komai da ke cikin kusurwa da ƙimar ka, kuma may gurbin maballi da maballi daga allon sarrafa ka.

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

An shiga? Na'urar sarrafa API da ke cikin sashin kulawarka tana cika ainihin lambar ƙungiyarka da maɓallinka naka, sannan tana gudanar da buƙatar a kan ainihin API don haka zaka iya ganin amsar gaske. Buɗe wannan tashar a cikin na'urar kula da API

Bayani

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

Jikin buƙata

Suna	Nau'i	Ana buƙata	Abin da yake
`host`	`string`	Eh	—
`port`	`integer`	A'a	—
`label`	`string`	A'a	—
`licence_id`	`Uuid`	A'a	—
`verify_tls`	`boolean`	A'a	—
`api_key`	`string`	A'a	A Plesk API key. Stored in Vault, never in a row.
`username`	`string`	A'a	—
`password`	`string`	A'a	The administrator's password. Stored in Vault, never in a row.

Martani

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

Kuskuren da wannan matsaya za ta iya maido wa

401 · 403 · 422 · 429

POST /v1/panels/connections