Snapshots

List snapshots (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/snapshots

Request

  • Base URL: https://app.mandala.computer/api/v1
  • URL: https://app.mandala.computer/api/v1/snapshots
  • 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. A snapshot on a host that cannot be reached is listed as its id and unreachable: true, and nothing else; a key scoped to a workspace gets no such rows, only the short answer. A row whose source computer cannot be found for certain carries computer_unreachable: true and no orphaned.

include'unfinished'

Widen the listing to snapshots whose deletion began and has not finished — their state reads deleting. Left out by default because a half-deleted snapshot is not one you can restore or clone, so a bare listing is the set you can actually act on. Poll with it to learn when a deletion has finished: the row goes then.

Response

Your snapshots — every one you can act on, plus unfinished deletions if you asked for them.

Changes

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