AMamika
SandboxSnapshots

Read a sandbox snapshot by name (default) or id

Changed on
get/api/v0beta1/rig-snapshots/{ref}

Request

  • Base URL
    https://app.amika.dev (the document declares no server; this is the origin it was published from)
  • URL
    https://app.amika.dev/api/v0beta1/rig-snapshots/{ref}
  • Auth
    • HTTP bearer
    • or API key in cookie wos-session

Path parameters

refstring required

Snapshot reference: its fully-qualified name (default) or row id. Use the by query param to choose.

Query parameters

by'name' | 'id' | 'ref' | 'name_or_id'

How to interpret the reference: name (default), id, or ref/name_or_id (matches either; rejects ambiguity).

Response

Snapshot.

idstring required
snapshotstring required
providerstring required
host_idstring nullable required
descriptionstring nullable required
source_sandbox_idstring nullable required
source_sandbox_namestring nullable required
repository_idstring nullable required
repository_urlstring nullable required
base_snapshotstring nullable required
sandbox_presetstring nullable required
sandbox_sizestring nullable required
capture_modestring nullable required
statestring required
error_messagestring nullable required

Changes