> ## Documentation Index
> Fetch the complete documentation index at: https://docs.boat.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# List saved snapshots

> List your saved snapshots, newest first.



## OpenAPI

````yaml openapi/boat-v1.yaml GET /saved-snapshots
openapi: 3.1.0
info:
  title: Boat Public API v1
  version: 1.0.0
  description: >
    Public JSON API for creating, operating, prompting, observing, and exposing
    sandboxes from backend services, CI jobs, hosted workers, and Boat
    automation products.


    The v1 reference intentionally documents the developer integration surface
    only. Dashboard billing actions are not part of v1.
servers:
  - url: https://boat.dev/api/v1
security:
  - BoatBearerAuth: []
tags:
  - name: Boat
    description: >-
      Unified Boat account, setup, lifecycle, prompting, event history, desktop
      access, and SSH operations.
paths:
  /saved-snapshots:
    get:
      tags:
        - Boat
      summary: List saved snapshots
      description: List your saved snapshots, newest first.
      operationId: listSavedSnapshots
      responses:
        '200':
          description: Saved snapshots owned by the authenticated Boat user.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SavedSnapshotListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    SavedSnapshotListResponse:
      allOf:
        - $ref: '#/components/schemas/SuccessBase'
        - type: object
          required:
            - snapshots
          properties:
            type:
              type: string
              const: snapshot.saved.list
            snapshots:
              type: array
              items:
                $ref: '#/components/schemas/SavedSnapshot'
            allowance:
              $ref: '#/components/schemas/SavedSnapshotAllowance'
    SuccessBase:
      type: object
      required:
        - ok
        - type
      properties:
        ok:
          type: boolean
          examples:
            - true
        type:
          type: string
          description: Stable success envelope discriminator added by v1.
    SavedSnapshot:
      type: object
      description: >-
        A saved snapshot: a frozen copy of a sandbox's disk at one moment, saved
        under a name you pick. Independent of the source sandbox's later life:
        the sandbox can change, stop, or be deleted and the saved snapshot still
        deploys. Saved snapshots never expire; re-saving a name replaces its
        artifact.
      required:
        - name
        - status
        - sourceSandboxId
        - createdAt
      properties:
        name:
          type: string
          pattern: ^[a-z0-9][a-z0-9-]{0,62}$
          description: The user-chosen handle, unique within your account.
        status:
          type: string
          enum:
            - saving
            - ready
            - failed
          description: >-
            `saving` while the capture and pin are in flight (a live source
            sandbox takes a fresh snapshot first, which can run minutes),
            `ready` when deployable, `failed` if the save did not complete (see
            `error`; save again to retry).
        error:
          type: string
          description: Failure reason. Only present when `status` is `failed`.
        sourceSandboxId:
          type: string
          description: The sandbox this snapshot was saved from (display only).
        snapshotId:
          type: string
          description: >-
            The frozen artifact behind the name. Present once `status` is
            `ready`. Accepted by `GET /api/boat/snapshots/{snapshotId}/tree` to
            browse its files.
        type:
          type: string
          description: Sandbox type the snapshot was saved from. Deploys default to it.
        sizeBytes:
          type: integer
          description: Restored content size of the frozen state, in bytes.
        createdAt:
          type: string
          format: date-time
    SavedSnapshotAllowance:
      type: object
      description: >-
        What the request's wallet (your active organization, `?org=`, or
        personal) pays for saved snapshots. 10 are free per wallet; each one
        above costs $1.70 a month, charged daily from usage. An organization's
        count includes every member's names billed to it.
      properties:
        org:
          type:
            - string
            - 'null'
          description: Organization the numbers are for. null = personal.
        orgName:
          type:
            - string
            - 'null'
          description: That organization's name.
        included:
          type: integer
          description: >-
            Saved snapshots the plan includes: 10 per $20 of plan per seat,
            never fewer than 10.
        free:
          type: integer
          deprecated: true
          description: Same value as included. Kept for older clients.
        used:
          type: integer
          description: Saved snapshots this wallet keeps.
        extra:
          type: integer
          description: Saved snapshots above the included ones.
        extraMonthlyDollars:
          type: number
          description: What the extra ones cost per month.
        extraDailyDollars:
          type: number
          description: >-
            Boat time the extra ones take per day, in dollars (the daily
            charge).
        pricePerExtraMonthlyDollars:
          type: number
          description: Monthly price of one extra saved snapshot.
    ErrorEnvelope:
      type: object
      required:
        - ok
        - type
        - status
        - code
        - message
        - error
        - requestId
      properties:
        ok:
          type: boolean
          examples:
            - false
        type:
          type: string
          examples:
            - sandbox.error
        status:
          type: integer
          examples:
            - 409
        code:
          type: string
          examples:
            - provider_not_configured
        message:
          type: string
          examples:
            - Prompting is locked until Codex is configured on the Agents page.
        requestId:
          type: string
          examples:
            - req_01HX...
        error:
          type: object
          required:
            - code
            - message
            - status
          properties:
            code:
              type: string
            message:
              type: string
            status:
              type: integer
            details:
              type: object
              additionalProperties: true
  responses:
    Unauthorized:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            unauthorized:
              value:
                ok: false
                type: sandbox.error
                status: 401
                code: unauthorized
                message: Unauthorized
                error:
                  code: unauthorized
                  message: Unauthorized
                  status: 401
                requestId: req_01HX...
  securitySchemes:
    BoatBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: sandbox_api_key
      description: >-
        Boat bearer token in the form `boat_...`. Service API keys authenticate
        sandbox operations.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.