compute

POST `/v1/panels/connections`

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

प्रमाणन

बेरर टोकन के रूप में एक API कुंजी भेजें। कुंजी के पास connections.manage अनुमति होनी चाहिए; इसके बिना एक कुंजी को 404 के बजाय 403 के साथ अस्वीकार कर दिया जाता है।

यह एंडपॉइंट कोई संगठन आईडी नहीं लेता है। आपकी कुंजी पहले से ही उस संगठन की पहचान करती है जिससे वह संबंधित है, और प्रतिक्रिया उसी के दायरे में है।

इसे आज़माएँ

कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।

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

साइन इन हैं? आपके डैशबोर्ड में मौजूद API कंसोल आपकी वास्तविक संगठन आईडी और आपकी अपनी कुंजी स्वतः भर देता है, और लाइव 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