compute

POST `/v1/panels/connections`

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

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 connections.manage 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。

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

已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。在 API 控制台中打开此端点

详细信息

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

请求正文

名称	类型	必填	内容简介
`host`	`string`	是	—
`port`	`integer`	否	—
`label`	`string`	否	—
`licence_id`	`Uuid`	否	—
`verify_tls`	`boolean`	否	—
`api_key`	`string`	否	A Plesk API key. Stored in Vault, never in a row.
`username`	`string`	否	—
`password`	`string`	否	The administrator's password. Stored in Vault, never in a row.

响应

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

此端点可能返回的错误

401 · 403 · 422 · 429

POST /v1/panels/connections