compute
POST /v1/panels/connections
Connect a running Plesk panel so it can be managed from here.
인증
Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 connections.manage 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.
이 엔드포인트는 조직 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