Skip to main content
GET
/
snapshots
List snapshots
curl --request GET \
  --url https://api.e2b.app/snapshots \
  --header 'X-API-Key: <api-key>'
[
  {
    "snapshotID": "<string>",
    "names": [
      "<string>"
    ]
  }
]

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
sandboxID
string

Filter snapshots by source sandbox ID

​
name
string

Filter snapshots by name or ID, optionally tag-qualified (e.g. "my-snapshot", "my-team/my-snapshot" or "my-snapshot:v1").

​
limit
integer<int32>
default:100

Maximum number of items to return per page

Required range: 1 <= x <= 100
​
nextToken
string

Cursor to start the list from

Response

Successfully returned snapshots

​
snapshotID
string
required

Identifier of the snapshot template including the tag. Uses namespace/alias when a name was provided (e.g. team-slug/my-snapshot:default), otherwise falls back to the raw template ID (e.g. abc123:default).

​
names
string[]
required

Full names of the snapshot template including team namespace and tag (e.g. team-slug/my-snapshot:v2)