compute

POST `/v1/panels/connections`

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

Kimlik Doğrulama

Bearer token olarak bir API anahtarı gönderin. Anahtar connections.manage iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.

Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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

İstek gövdesi

Ad	Tür	Zorunlu	Ne olduğu
`host`	`string`	Evet	—
`port`	`integer`	Hayır	—
`label`	`string`	Hayır	—
`licence_id`	`Uuid`	Hayır	—
`verify_tls`	`boolean`	Hayır	—
`api_key`	`string`	Hayır	A Plesk API key. Stored in Vault, never in a row.
`username`	`string`	Hayır	—
`password`	`string`	Hayır	The administrator's password. Stored in Vault, never in a row.

Yanıt

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

Bu uç noktanın dönderebileceği hatalar

401 · 403 · 422 · 429

POST /v1/panels/connections