Restart a computer
Resets the guest — the equivalent of the reset button, not a fresh boot of a new machine. Changes that need a different QEMU command line, such as a resize, need a stop and a start instead. A stopped computer with no secrets bound is started instead, and that start can be refused like any other, including with 503 while its host is low on disk space (see POST /computers/{id}/start); a suspended one answers 409 — start it to resume, or stop it to discard the session.
A restart issues new desktop credentials and closes open desktop and terminal connections, so a vnc.url from before it stops working: read the computer again for a fresh one.
A computer that holds secrets gets them again as it comes back up, on any host that seals saved sessions. It answers 409 when it is stopped, with reason: unavailable — start it instead, which delivers them — while its secrets are still being delivered, with reason: contention, which passes in a moment, and on a host that cannot deliver them again, with reason: unsupported, where a stop and a start is the way to restart it — as it is for a session its secrets were never delivered to and that nothing is delivering to now, also reason: unsupported. For such a session, a host that could not read whether it is running just now answers reason: contention (send it again shortly), and one that cannot read its process until support repairs the host answers reason: unsupported. After a restart, secrets_delivering reads true before the computer is back up; a restart is still accepted then, for a computer that does not come back, and is refused with reason: contention only once the delivery has begun.
A computer the platform is holding for disk-space recovery, after a suspend or memory snapshot failed at any free space (see POST /computers/{id}/suspend), answers 503 (“waiting for disk-space recovery”), running or stopped, before anything is reset or any credential changes. Wait for it to resume by itself, or stop it to discard the paused session. One that is paused because its host ran out of disk space, still reading running, answers 503 too, saying so, and keeps its session: it resumes by itself once space is freed, so restart it then, or stop it. One its host paused while low on disk space is restarted, and comes back once space has been freed. A restart that finds another operation holding the computer’s monitor answers 409 with reason: contention and changes nothing; send it again.
Requires the member role or higher.
Request
- Base URL: https://app.mandala.computer/api/v1
- URL: https://app.mandala.computer/api/v1/computers/{id}/restart
- Auth: HTTP bearer
Path parameters
The computer id.
Headers
Optional: a key of your choosing, 1 to 255 printable ASCII characters with no spaces (a UUID is ideal), that makes this call safe to send again after a lost answer. The call and its operation are recorded BEFORE it is carried out, so GET /operations?idempotency_key= finds it however the connection ended. For 24 hours, the same key with the byte-identical request (method, path, query and body, from a credential of the same scope) is not carried out again: it answers 409 idempotency_in_progress while the first is running, and the original answer — status and body, with Idempotent-Replayed: true — once it has finished. An answer too large to keep (over 1 MiB) is replayed instead as a 200 carrying {operation_id, operation}, also with Idempotent-Replayed: true: operation is the call’s operation, or null when there is none to show. Keys are kept per scope: a key used by a workspace's credential and the same key used by another workspace's, or by an account-wide one, are different keys, and neither is refused because of the other. A replayed body omits the desktop credentials the original carried (vnc, with its tokens and URLs): read the computer (GET /computers/{id}) for them. The same key on a different request is a 422 with code: "idempotency_key_reused", and a malformed key (empty, too long, outside printable ASCII, or the header sent twice) a 400 with code: "idempotency_key_invalid"; neither does anything. A call refused with a 4xx that did nothing releases its key, so it may be sent again under the same one. The exception is a delete whose 4xx says the computer was deleted — computer_deleted: true, or a purge result beside computer_deleted: false (it was deleted, then listed again): it happened, so its key keeps that answer and its operation is succeeded. Except a 409 with reason: "contention" whose purge deleted, queued and left in doubt nothing (the computer was already gone and copies in use refused the purge): nothing happened, so its key is released and the same request may be sent again under it. With computer_deleted: null, or false where the platform cannot confirm the computer was left in place, it is an unknown outcome: its key answers 409 idempotency_in_progress until the platform gives up on it, then 409 idempotency_outcome_unknown. A 5xx answer that names an operation_id is an unknown outcome too: that is the operation reserved for it. From then on the same key answers 409 idempotency_outcome_unknown, naming that operation (not idempotency_in_progress): read the computer, or the operation. The operation stays pending until the platform gives up on it; if it never learns how the call ended, it becomes failed with error.code: "lost". Some 5xx answers are refusals given before the call was sent anywhere — the platform could not check the account’s usage, or find a host for the call, for example — and some are a create or clone the host confirms it refused before building anything, such as a 503 from a host with no room left, and some are a start, restore or suspend the host confirms it refused before changing anything (a sealed session whose key could not be opened or whose transport failed first; on a suspend, suspend_outcome: "not_started"). Those name no operation_id: nothing was done, so the key is released as a 4xx refusal’s is, and the same call may be sent again under the same key. A host running older software cannot confirm such a refusal, so its 5xx is an unknown outcome like any other. A 5xx without an operation_id is not proof that nothing was done on its own: a call that records no operation (a PATCH that does not resize) names none, and neither does one whose operation could not be recorded. Sending the same call again under the same key is safe after any 5xx: it is carried out if its key was released, and answered 409 idempotency_outcome_unknown if not.
Response
Restarting.
Changes
No recorded changes to this operation across all 1 revision of this API.