compute

POST `/v1/compute/servers/{serverId}/rescue`

Turn rescue mode on or off. ⛔ Restarts 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}/rescue \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "enabled": <boolean> }'

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

On: the machine restarts into a rescue system that can read and change everything on its disk, with the machine's SSH keys installed. Requires sites.delete and the server's name typed in confirm (checked server-side). The rescue system's root password is in the response once; it is never logged, audited or stored. Off: requires sites.restart; the machine restarts from its own disk. restarted is false when the machine could not be restarted (for example a billing hold) — start it yourself.

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
`enabled`	`boolean`	Yes	—
`confirm`	`string`	No	The server's name, typed exactly. Required when `enabled` is true.

Response

Name	Type	Required	What it is
`rescue_enabled`	`boolean`	Yes	—
`restarted`	`boolean`	Yes	—
`root_password`	`object`	Yes	The rescue system's root password, shown once. `null` when off.

Errors this endpoint can return

401 · 403 · 404 · 422 · 429 · 503

POST /v1/compute/servers/{serverId}/rescue