compute
POST /v1/compute/servers/{serverId}/add-on/panel-login
Enable one-click Plesk sign-in on this machine, with your consent.
Authentication
Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/compute/servers/{serverId}/add-on/panel-login \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "consent": <boolean>, "access": <object> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
PLESK-SSO self-serve (docs/1112 §6). For a machine whose Plesk add-on is active but was installed before one-click sign-in existed, so the server page shows no Open Plesk. With your consent and a one-time access to the machine, the platform creates a Plesk API key on it that is bound to one address of ours (the pinned egress for "Plesk on our servers"), proves it can mint a single-use login, and stores it in Vault. Open Plesk then works for you and for our support, every login single-use and audited. Requires sites.view and sites.panel_access — the key that already opens the panel. It changes no price. ⛔⛔ access is write-only: never echoed, logged or audited. It is stored in Vault under a path scoped to this add-on, used once by a Temporal workflow, and deleted when that run ends, whatever the outcome. consent must be true. Answers 202: panel_login_step reads enabling until the run ends, then "" with panel_connection_id set (enabled), or the reason token it stopped on (panel_unreachable, panel_key_refused, egress_not_pinned, …). Refused 422 when the machine has no active Plesk add-on, is already enabled, or a run is in progress. 503 when the run could not be started — the access is deleted before it answers.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
serverId (path) | Uuid | Yes | The server's id, as listComputeServers reports it. Ours (UUIDv7), minted when the order row was written — never the provider's own identifier for the machine. |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
consent | boolean | Yes | Must be true — the customer agrees to the sign-in key. |
access | object | Yes | One-time access to the machine, as for an add-on install on a running machine. ⛔⛔ Write-only. Supply private_key or password. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | ComputeAddOnAssignment | Yes | One machine's add-on — what was bought, what it costs, and where it has got to. ⛔ Never carries the licence key or the vendor's reference. Key material belongs in Vault; a… |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429 · 503