Computers

List computers (headers only)

The GET of this path with no response body. It is authorized exactly as the GET is and answers its statuses and headers, never a body: an error’s correlation is in X-Request-ID alone. Range is ignored. It runs the GET’s own read and discards the body, so it touches whatever that read touches, the guest included: it is not a lighter way to poll.

Requires the viewer role or higher.

head/computers

Request

  • Base URL: https://app.mandala.computer/api/v1
  • URL: https://app.mandala.computer/api/v1/computers
  • Auth: HTTP bearer

Query parameters

allow_partial'1' | 'true'

Accept a listing known to be short. Without it this endpoint answers 503 when a hypervisor holding some of your things cannot be reached, because a short list is not a smaller truth — it reads exactly like the missing ones were deleted, and the obvious next thing a script does with something that has disappeared is tidy it up. Rows served this way carry unreachable: true and the identity the platform keeps for the computer, and nothing its host alone knows.

state'live' | 'unreachable' | 'deleting' | 'deleted' | 'lost'

Only computers in this lifecycle state — see state on Computer. Without it the listing is every computer that exists or may exist: live, unreachable and deleting. deleted and lost rows are answered from the platform’s record alone, since no host has them to list, and this parameter is the only way they are shown. An unreachable row is one no host answered for, which makes the listing short, so state=unreachable without allow_partial=1 answers either [] or a 503.

workspace_idstring

Only the computers in this workspace — an id from GET /workspaces — or, with unassigned, only the computers in no workspace. A workspace id answers exactly what a key scoped to that workspace would list, the platform’s own rows for unreachable and ended computers included. It combines with state. A workspace this key cannot reach — another account’s, one that does not exist, or any but its own for a key scoped to a workspace — is a 404, and so is unassigned from a scoped key, which cannot see those computers at all.

Response

Your computers.

Changes

No recorded changes to this operation across all 1 revision of this API.