---
title: "List snapshots"
method: GET
path: "/api/v2/sandboxes/snapshots"
tags: ["sandboxes"]
---

# List snapshots

`GET /api/v2/sandboxes/snapshots`

## Request

- Base URL: `https://api.smith.langchain.com`
- URL: `https://api.smith.langchain.com/api/v2/sandboxes/snapshots`
- Auth: one of:
  - API key in header `X-API-Key`
  - API key in header `X-Tenant-Id`
  - HTTP bearer

List workspace and published system snapshots, with optional filtering, sorting, and pagination.
Page with page_size and cursor: replay the response's next_cursor until it comes back null, which is the only signal that no pages remain.
Cursors are opaque and only valid on this endpoint; do not parse or construct one.

## Query parameters

- `page_size` integer
- `cursor` string
- `limit` integer
- `offset` integer
- `name_contains` string
- `status` string
- `created_by` string
- `label` string[]
- `sort_by` string
- `sort_order` string
- `sort_direction` string

## Response `200`

OK

- SandboxesSnapshotListResponse
  - `items` SandboxesSnapshotResponse[]: This page of snapshots.
    - `created_at` string
    - `created_by` string
    - `description` string: Description says what this snapshot's image can do, so a caller can hand it to an agent as a capability summary.
    - `docker_image` string
    - `fs_capacity_bytes` integer
    - `fs_used_bytes` integer
    - `id` string
    - `image_digest` string
    - `included` string[]: The settings this snapshot carries, in include terms: sandboxes created from it start with each one their create request leaves unset. Env var values are never returned.
    - `labels` SandboxesLabels
    - `memory_snapshot_size_bytes` integer: MemorySnapshotSizeBytes is non-nil iff the snapshot was captured with VM memory state. A non-nil value is the canonical signal that this snapshot can warm-restore from memory; nil means rootfs only.
    - `mount_config` SandboxesSandboxMountConfig (unresolved $ref)
    - `name` string
    - `proxy_config` SandboxesProxyConfig
      - `access_control` SandboxesAccessControl
        - `allow_list` string[]
        - `deny_list` string[]
      - `callbacks` SandboxesCallback[]
        - `full_request` boolean
        - `match_hosts` string[], required
        - `request_headers` SandboxesProxyHeader[]
          - `is_set` boolean
          - `name` string, required
          - `type` 'plaintext' | 'opaque' | 'workspace_secret', required
          - `value` string
        - `ttl_seconds` integer, required
        - `url` string, required
      - `description` string: Description says what this configuration as a whole lets the sandbox reach, complementing the per-rule descriptions. At most 1024 characters.
      - `no_proxy` string[]
      - `rules` SandboxesProxyRule[] (unresolved $ref)
    - `registry_id` string
    - `run_config` SandboxapiRunConfig
      - `env_vars` object
      - `user` string
      - `work_dir` string
    - `source_sandbox_id` string
    - `status` string
    - `status_message` string
    - `tags` string[]: Tags currently resolving to this snapshot, under Name. A snapshot with no tags is dangling — addressable only by id.
    - `updated_at` string
  - `next_cursor` string: Cursor for the next page, or null on the last page. A non-null value is the only signal that more pages exist. Treat it as opaque.
  - `offset` integer: Deprecated: use next_cursor. Offset to request for the next page, or 0 when no pages remain.
  - `snapshots` SandboxesSnapshotResponse[]: Deprecated: use items. Duplicates items.
    - `created_at` string
    - `created_by` string
    - `description` string: Description says what this snapshot's image can do, so a caller can hand it to an agent as a capability summary.
    - `docker_image` string
    - `fs_capacity_bytes` integer
    - `fs_used_bytes` integer
    - `id` string
    - `image_digest` string
    - `included` string[]: The settings this snapshot carries, in include terms: sandboxes created from it start with each one their create request leaves unset. Env var values are never returned.
    - `labels` SandboxesLabels
    - `memory_snapshot_size_bytes` integer: MemorySnapshotSizeBytes is non-nil iff the snapshot was captured with VM memory state. A non-nil value is the canonical signal that this snapshot can warm-restore from memory; nil means rootfs only.
    - `mount_config` SandboxesSandboxMountConfig (unresolved $ref)
    - `name` string
    - `proxy_config` SandboxesProxyConfig
      - `access_control` SandboxesAccessControl
        - `allow_list` string[]
        - `deny_list` string[]
      - `callbacks` SandboxesCallback[]
        - `full_request` boolean
        - `match_hosts` string[], required
        - `request_headers` SandboxesProxyHeader[]
          - `is_set` boolean
          - `name` string, required
          - `type` 'plaintext' | 'opaque' | 'workspace_secret', required
          - `value` string
        - `ttl_seconds` integer, required
        - `url` string, required
      - `description` string: Description says what this configuration as a whole lets the sandbox reach, complementing the per-rule descriptions. At most 1024 characters.
      - `no_proxy` string[]
      - `rules` SandboxesProxyRule[] (unresolved $ref)
    - `registry_id` string
    - `run_config` SandboxapiRunConfig
      - `env_vars` object
      - `user` string
      - `work_dir` string
    - `source_sandbox_id` string
    - `status` string
    - `status_message` string
    - `tags` string[]: Tags currently resolving to this snapshot, under Name. A snapshot with no tags is dangling — addressable only by id.
    - `updated_at` string

## Other responses

- `400`: invalid page_size, cursor, or sort_order, or a deprecated parameter combined with its replacement
- `403`: Forbidden
- `422`: invalid limit or offset
- `500`: Internal Server Error

## Changes

- **2026-10-26** `dfe647d1748e`: 2 info
  - added the optional property `items/items/proxy_config/allOf[#/components/schemas/sandboxes.ProxyConfig]/rules/items/relay_id` to the response with the `200` status
  - added the optional property `snapshots/items/proxy_config/allOf[#/components/schemas/sandboxes.ProxyConfig]/rules/items/relay_id` to the response with the `200` status
- **2026-10-19** `9aeaab9f0a28`: 6 info
  - added the optional property `items/items/included` to the response with the `200` status
  - added the optional property `items/items/mount_config` to the response with the `200` status
  - added the optional property `items/items/proxy_config` to the response with the `200` status
  - added the optional property `snapshots/items/included` to the response with the `200` status
  - …2 more
- **2026-10-16** `1a8ee9358d81`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/langchain-ai/apis/langsmith/changes/api/v2/sandboxes/snapshots/get.md)

---

[API](https://skmtc.dev/langchain-ai/apis/langsmith.md) - [All operations](https://skmtc.dev/langchain-ai/apis/langsmith/llms.txt) - [OpenAPI document](https://skmtc.dev/langchain-ai/apis/langsmith/revisions/7a01c01f75e8?raw)