Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Manage Snapshots

This page provides the basic commands for managing a snapshot.

Get a Snapshot

Retrieve information about one snapshot by ID or alias with the HTTP API:

curl -H 'X-API-Key: test-key' \
  http://127.0.0.1:8000/snapshots/<snapshot-id-or-alias>

List Snapshots

aenv snapshot list
aenv snapshot list --sandbox-id <sandbox-id>

aenv snapshot ls is an alias for aenv snapshot list.

OptionDefaultDescription
--sandbox-id <sandbox-id>All snapshotsShows only snapshots created from the specified sandbox, including after that sandbox is deleted.
--output <table|json>Table in an interactive terminal; JSON when redirectedSelects the output format.

Delete a Snapshot

Snapshots and templates share the same catalog. Delete a snapshot by passing its required ID or alias to the template delete command:

aenv template delete <snapshot-id-or-name>