compute

POST `/v1/panels/connections`

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

Xaqiijinta aqoonsiga

U dir furaha API ah calaamad dusha ah (bearer token). Furaha waa inuu wataa ruqadda connections.manage; furaha aan wadan waxaa loo diidayaa 403, ee ma aha 404.

Boggan ma qaato aqoonsiga ururka. Furahaagu wuxuu horay u aqoonsanayaa ururka uu ka tirsan yahay, jawaabtuna waxay ku kooban tahay halkaas.

Isku day

Ku beddel wax kasta oo ku dhex jira qeebaha xaglaha ah qiimayaashaada, sidoo kalena haystaaha furaha ku beddel fure ka dhex muuqda dashboordigaaga.

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

Ma sign-garaysay? Qalabka API ee ku jira dashboard-kaagu wuxuu buuxiyaa aqoonsigaaga ururka ee dhabta ah iyo furahaaga gaarka ah, wuxuuna ku shaqeysiiyaa codsiga API-ga nool si aad u aragto jawaabta dhabta ah. Kani ka fur barta kontoroolka ee API

Details

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

Codsiga jidhkiisa

Magaca	Nooc	Loo baahan yahay	Maxay tahay
`host`	`string`	Haa	—
`port`	`integer`	Maya	—
`label`	`string`	Maya	—
`licence_id`	`Uuid`	Maya	—
`verify_tls`	`boolean`	Maya	—
`api_key`	`string`	Maya	A Plesk API key. Stored in Vault, never in a row.
`username`	`string`	Maya	—
`password`	`string`	Maya	The administrator's password. Stored in Vault, never in a row.

Jawaab

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

Cilladaha ay bartaani soo celin karto

401 · 403 · 422 · 429

POST /v1/panels/connections