E2e2b-dev
snapshots

List snapshots

Changed on

List all snapshots for the team

get/snapshots

Request

  • Base URL
    https://api.e2b.app
  • URL
    https://api.e2b.app/snapshots
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer and API key in header X-Team-ID
    • or API key in header X-Admin-Token and API key in header X-Team-ID
    • or HTTP bearer and API key in header X-Team-ID

Query parameters

sandboxIDstring

Filter snapshots by source sandbox ID

namestring

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

limitinteger

Maximum number of items to return per page

nextTokenstring

Cursor to start the list from

Response

Successfully returned snapshots

snapshotIDstring 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).

namesstring[] required

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

Changes