compute
POST /v1/compute/servers/{serverId}/root-password
Reset a server's root password. ⛔ Reboots the machine.
Authentication
Send an API key as a bearer token. The key must carry the sites.delete 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}/root-password \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "password": <string>, "confirm": <string> }'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
⭐⭐ **The other half of "I am locked out of my own server"**, and the half a console alone does not solve: the console gets you to a login prompt, and this is what you type into it when the password is the thing you lost. ⛔⛔ **The machine reboots.** The provider restarts the guest as part of applying the change, so everything running on it goes offline for a minute or two. A surface offering this must say so *before* the button, not in the result. ⛔ Requires `sites.delete`, **not** `sites.restart`: a root password is total control of the machine and everything on it, which is the same order of trust as destroying it. The server's name must be typed to confirm, and that is checked server-side — a dialog the client owns is a dialog an API caller never sees. ⛔ At least 16 characters, length only and no composition rules: this credential faces the public internet on port 22, and length is what makes it hard to guess. The value is never logged, never audited and never echoed back. `503` on a range whose provider publishes no reset (our own cloud installs an SSH key instead and mints no root password at all).
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 |
|---|---|---|---|
password | string | Yes | The new root password. At least 16 characters. |
confirm | string | Yes | The server's name, typed exactly. |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429 · 503