compute
POST /v1/panels/connections
Connect a running Plesk panel so it can be managed from here.
ਪ੍ਰਮਾਣੀਕਰਨ
API ਕੁੰਜੀ ਨੂੰ ਇੱਕ ਬੇਅਰਰ ਟੋਕਨ (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 ਕੰਸੋਲ ਤੁਹਾਡੀ ਅਸਲ ਸੰਸਥਾ ਆਈਡੀ (organisation 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