Delete a computer
Destroys the computer, keeping snapshots by default. With snapshots=delete, deletes the computer while keeping its snapshots, then deletes only the selected physical snapshot copies across the fleet. Copies with the same ID on different hosts count separately.
Read GET /computers/{id}/snapshots and pass its fingerprint as expect. A stale fingerprint returns 409 before any mutation. If expect is omitted, a fresh complete inventory defines the selected copies for this explicit purge request. Unavailable inventory or an active capture prevents purge; ordinary deletion keeping snapshots remains available.
An active capture, and a computer being moved between hosts, answer 409 with reason: "contention": send the same request again once it finishes (with expect, a capture that has finished changes the fingerprint, so read the holdings again). A stale fingerprint, a changed fleet and changed ownership carry no reason. A host that refuses the computer’s own delete passes its reason on — contention while another delete, or a copy of its disk, is already running.
Inspect computer_deleted and purge even on success: 202 means work remains queued. Partial refusals return 409; unknown transport or incomplete final inventory returns 503. A computer already deleted before this request, whose purge deleted no copy and was refused only by copies still in use (a clone reading one, say), carries reason: "contention" when it was sent with expect: send the same request again once they are free, and any copy that appeared since is refused before anything is deleted. No uncertain delete is replayed automatically. Refresh holdings before an explicit retry, including after the computer is gone. The final inventory reports new unselected copies; those need new consent. Completion covers the selected copies as observed, not a guarantee that no later import can appear.
Requires the member role or higher.
Request
- Base URL: https://app.mandala.computer/api/v1
- URL: https://app.mandala.computer/api/v1/computers/{id}
- Auth: HTTP bearer
Path parameters
The computer id.
Query parameters
Delete this computer’s snapshots along with it. Omit to keep them.
The fingerprint from GET /computers/{id}/snapshots. Makes the purge binding on the set you were shown. Ignored unless snapshots=delete.
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
Computer deletion and physical-copy cleanup outcomes; 202 is pending, not completion.
Changes
No recorded changes to this operation across all 1 revision of this API.