compute

POST /v1/panels/connections

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

બધા compute એન્ડપૉઇન્ટ્સ

બધા ડેવલપર દસ્તાવેજો

પ્રમાણીકરણ

એપીઆઈ કી (API key) ને બેરર ટોકન તરીકે મોકલો. કી પાસે connections.manage પરવાનગી હોવી આવશ્યક છે; તેના વગરની કીને 404 ને બદલે 403 સાથે અસ્વીકાર કરવામાં આવશે.

આ એન્ડપૉઇન્ટ કોઈ સંસ્થા આઈડી (organisation id) લેતું નથી. તમારી કી (key) પહેલેથી જ તે જે સંસ્થા સાથે સંબંધિત છે તેની ઓળખ કરે છે, અને પ્રતિસાદ (response) તે જ પૂરતો મર્યાદિત છે.

આયમાવો

કોઈપણ કૌંસમાં રહેલી બાબતને તમારા પોતાના મૂલ્યોથી બદલો અને કી પ્લેસહોલ્ડરને તમારા ડેશબોર્ડની કીથી બદલો.

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.

રિકવેસ્ટ બોડી

નામપ્રકારજરૂરીતે શું છે
hoststringહા
portintegerના
labelstringના
licence_idUuidના
verify_tlsbooleanના
api_keystringનાA Plesk API key. Stored in Vault, never in a row.
usernamestringના
passwordstringનાThe administrator's password. Stored in Vault, never in a row.

જવાબ

નામપ્રકારજરૂરીતે શું છે
idUuidહાUUIDv7 identifier — sortable by creation time (docs/02 §8).
hoststringહા
portintegerહા
panelstringહા
labelstringહા
licence_idUuidહા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_capabilitiesstring[]હા⛔⛔ 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_versionstringહા
panel_hostnamestringહાThe panel's own hostname, which need not be the host we connect to.
licence_namestringહાThe edition the panel reports it is licensed for.
verify_tlsbooleanહા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_atstringહાnull means never checked, which is not the same as failed. A client must render the two differently.
last_errorstringહા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