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

# List sandbox volumes

> Lists persistent volumes in a team.

Related guide: [Sandbox volumes](https://docs.baseten.co/sandboxes/volumes.md).


## OpenAPI

````yaml get /v1/sandboxes/volumes
openapi: 3.1.0
info:
  description: REST API for management of Baseten resources
  title: Baseten management API
  version: 1.0.0
servers:
  - url: https://api.baseten.co
security:
  - BearerAuth: []
paths:
  /v1/sandboxes/volumes:
    get:
      tags:
        - Volumes
      summary: List volumes
      description: >-
        Return a cursor-paginated page of persistent volumes, newest first. Keep
        q and status unchanged when following a cursor.
      operationId: ListSandboxVolumes
      parameters:
        - $ref: '#/components/parameters/TeamId'
        - $ref: '#/components/parameters/TeamIdHeader'
        - $ref: '#/components/parameters/Cursor'
        - $ref: '#/components/parameters/Limit'
        - name: q
          in: query
          description: Search volume names. Search is applied before pagination.
          required: false
          schema:
            type: string
            example: datasets
        - name: status
          in: query
          description: >-
            Volume statuses. Repeat the query parameter for each status, for
            example status=DEPLOYED&status=FAILED. Unknown values are rejected.
          required: false
          style: form
          explode: true
          schema:
            type: array
            minItems: 1
            items:
              $ref: '#/components/schemas/SandboxVolumeStatusV1'
      responses:
        '200':
          description: Successful operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSandboxVolumesResponseV1'
              examples:
                page:
                  $ref: '#/components/examples/SandboxVolumesPage'
        '400':
          $ref: '#/components/responses/SandboxError400'
        '401':
          $ref: '#/components/responses/SandboxError401'
        '403':
          $ref: '#/components/responses/SandboxError403'
        '429':
          $ref: '#/components/responses/SandboxError429'
        '500':
          $ref: '#/components/responses/SandboxError500'
components:
  parameters:
    TeamId:
      name: team_id
      in: query
      required: false
      description: >-
        Optional team ID. Must match X-Team-Id when both are supplied. If
        neither selector is supplied, defaults to the caller's only accessible
        team. Callers with multiple accessible teams must select a team.
        Requests without access to any team are forbidden.
      schema:
        minLength: 1
        type: string
    TeamIdHeader:
      name: X-Team-Id
      in: header
      required: false
      description: >-
        Optional team ID. Must match the team_id query parameter when both are
        supplied. If neither selector is supplied, defaults to the caller's only
        accessible team. Callers with multiple accessible teams must select a
        team. Requests without access to any team are forbidden.
      schema:
        minLength: 1
        type: string
    Cursor:
      name: cursor
      in: query
      required: false
      description: Opaque cursor from the previous page; omit for the first page.
      schema:
        type: string
        example: >-
          eyJ2IjoxLCJsYXN0X2tleSI6ImJhc2V0ZW4tYXBpLXJldmlldy0wOTE2Iiwic29ydCI6ImRlc2MifQ
    Limit:
      name: limit
      in: query
      required: false
      description: Maximum number of items to return.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
        example: 20
  schemas:
    SandboxVolumeStatusV1:
      type: string
      description: Volume status, always uppercase.
      enum:
        - DEPLOYING
        - DEPLOYED
        - FAILED
        - DELETING
      example: DEPLOYED
    ListSandboxVolumesResponseV1:
      type: object
      description: One page of volumes.
      properties:
        items:
          type: array
          description: Resources on this page.
          items:
            $ref: '#/components/schemas/SandboxVolumeV1'
        pagination:
          $ref: '#/components/schemas/SandboxApiPaginationV1'
      required:
        - items
        - pagination
    SandboxVolumeV1:
      type: object
      description: Persistent volume.
      properties:
        name:
          type: string
          description: >-
            Volume name, used in volume_name path parameters and sandbox
            volumes.
          readOnly: true
          example: datasets
        size:
          oneOf:
            - type: string
            - type: integer
          x-go-type: VolumeSize
          description: >-
            Capacity, as a size (e.g. "10Gi", "512Mi") or a number of Mi (e.g.
            1024).
          example: 10Gi
        region:
          type: string
          description: Region of the volume.
          example: us-pdx-1
        status:
          $ref: '#/components/schemas/SandboxVolumeStatusV1'
        attached_to:
          type: string
          description: >-
            Name of the sandbox the volume is mounted in. Absent when not
            mounted.
          readOnly: true
          example: baseten-api-review-0916
        labels:
          description: Labels. Omitted from list responses.
          allOf:
            - $ref: '#/components/schemas/SandboxMetadataLabelsV1'
        created_at:
          type: string
          format: date-time
          readOnly: true
          example: '2026-10-12T12:00:00Z'
        updated_at:
          type: string
          format: date-time
          readOnly: true
          example: '2026-10-12T12:00:00Z'
        created_by:
          type: string
          description: User or service account that created the volume.
          readOnly: true
          example: sandbox-automation
        updated_by:
          type: string
          description: User or service account that last updated the volume.
          readOnly: true
          example: sandbox-automation
      required:
        - name
        - size
        - region
        - status
    SandboxApiPaginationV1:
      type: object
      description: >-
        Cursor pagination information. The cursor is present only when another
        page is available.
      properties:
        has_more:
          type: boolean
          description: Whether another page is available.
          example: true
        cursor:
          type: string
          description: >-
            Opaque cursor to pass to the next list request. Keep the same
            filters.
          minLength: 1
          example: >-
            eyJ2IjoxLCJsYXN0X2tleSI6ImJhc2V0ZW4tYXBpLXJldmlldy0wOTE2Iiwic29ydCI6ImRlc2MifQ
      required:
        - has_more
      example:
        has_more: true
        cursor: >-
          eyJ2IjoxLCJsYXN0X2tleSI6ImJhc2V0ZW4tYXBpLXJldmlldy0wOTE2Iiwic29ydCI6ImRlc2MifQ
    SandboxMetadataLabelsV1:
      type: object
      description: >-
        Key-value pairs for organizing and filtering resources. Labels can be
        used to categorize resources by environment, project, team, or any
        custom taxonomy.
      additionalProperties:
        type: string
      example:
        env: development
        project: api-review
        team: engineering
  examples:
    SandboxVolumesPage:
      summary: Last page of volumes
      value:
        items:
          - name: datasets
            size: 10Gi
            region: us-pdx-1
            status: DEPLOYED
            attached_to: baseten-api-review-0916
            created_at: '2026-10-12T12:00:00Z'
            updated_at: '2026-10-12T12:00:00Z'
            created_by: sandbox-automation
            updated_by: sandbox-automation
        pagination:
          has_more: false
  responses:
    SandboxError400:
      description: >-
        Invalid request. Returns a JSON error with code, message, and optional
        details.
      content:
        application/json:
          example:
            code: INVALID_REQUEST
            message: One or more request parameters are invalid.
            details:
              request_id: a3b7c4d2-91e6-4f08-9b5a-2c6d7e8f1043
    SandboxError401:
      description: >-
        Missing or invalid authentication. Returns a JSON error with code,
        message, and optional details.
      content:
        application/json:
          example:
            code: UNAUTHORIZED
            message: Provide a valid authentication token in the Authorization header.
            details:
              header: Authorization
    SandboxError403:
      description: >-
        Insufficient permissions. Returns a JSON error with code, message, and
        optional details.
      content:
        application/json:
          example:
            code: FORBIDDEN
            message: >-
              This authentication token does not grant permission to perform
              this operation.
            details:
              request_id: a3b7c4d2-91e6-4f08-9b5a-2c6d7e8f1043
    SandboxError429:
      description: >-
        Request limit exceeded. Returns a JSON error with code, message, and
        optional details.
      content:
        application/json:
          example:
            code: RATE_LIMITED
            message: Too many requests. Try again in 30 seconds.
            details:
              retry_after_seconds: 30
    SandboxError500:
      description: >-
        Internal server error. Returns a JSON error with code, message, and
        optional details.
      content:
        application/json:
          example:
            code: INTERNAL_ERROR
            message: The request could not be completed. Try again later.
            details:
              request_id: a3b7c4d2-91e6-4f08-9b5a-2c6d7e8f1043
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Send `Authorization: Bearer <api_key>`. The legacy `Authorization:
        Api-Key <api_key>` scheme is also accepted.

````