compute

POST `/v1/panels/connections`

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

ავტორიზაცია

API გასაღები გაგზავნეთ როგორც მატარებელი ტოკენი (bearer token). გასაღებს უნდა ჰქონდეს connections.manage ნებართვა; ამის გარეშე გასაღები უარყოფილი იქნება 403 და არა 404 სტატუსით.

ეს ბოლო წერტილი არ იღებს ორგანიზაციის იდენტიფიკატორს. თქვენი გასაღები უკვე აიდენტიფიცირებს იმ ორგანიზაციას, რომელსაც ის ეკუთვნის, და პასუხი შემოფარგლულია მისით.

სცადეთ

შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.

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-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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…
`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…
`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…

შეცდომები, რომლებიც ამ ენდპოინტს შეუძლია დააბრუნოს

401 · 403 · 422 · 429

POST /v1/panels/connections