compute

POST `/v1/panels/connections`

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

Pengesahan

Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran connections.manage; kunci yang tidak mempunyainya akan ditolak dengan 403, bukan 404.

Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.

Cuba

Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.

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

Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API

Butiran

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

Badan permintaan

Nama	Jenis	Diperlukan	Apakah ia
`host`	`string`	Ya	—
`port`	`integer`	Tidak	—
`label`	`string`	Tidak	—
`licence_id`	`Uuid`	Tidak	—
`verify_tls`	`boolean`	Tidak	—
`api_key`	`string`	Tidak	A Plesk API key. Stored in Vault, never in a row.
`username`	`string`	Tidak	—
`password`	`string`	Tidak	The administrator's password. Stored in Vault, never in a row.

Respons

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

Ralat yang boleh dikembalikan oleh titik akhir ini

401 · 403 · 422 · 429

POST /v1/panels/connections