compute

POST `/v1/panels/connections`

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

प्रमाणीकरण

एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। कुञ्जीसँग 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