---
title: "List all volumes."
method: GET
path: "/v1/{tenantId}/volumes"
tags: ["Volume"]
---

# List all volumes.

`GET /v1/{tenantId}/volumes`

## Request

- Base URL: `https://virtserver.swaggerhub.com/open83/crystal/1.0.0`
- URL: `https://virtserver.swaggerhub.com/open83/crystal/1.0.0/v1/{tenantId}/volumes`
- Auth: none declared

## Query parameters

- `backendId` string
- `offset` integer
- `limit` integer
- `sort` string

## Response `200`

successful operation.

- object
  - `volumes` VolumeResult[]
    - `Id` string: The volume ID, generated by server
    - `CreatedAt` string: The time of creation of the volume.
    - `UpdatedAt` string: The time at which the volume was updated.
    - `TenantId` string: The tenant UUID in a multi-tenancy environment.
    - `UserId` string: The user UUID in a multi-tenancy environment.
    - `BackendId` string: The backend ID
    - `Backend` string: The backend Name.
    - `Name` string: The volume name specified by user.
    - `Description` string: The volume description specified by user.
    - `Type` string: The volume type.
    - `Size` integer: The volume size.
    - `Region` string: The region for the volume.
    - `AvailabilityZone` string: The availability zone for the volume.
    - `Status` 'available' | 'creating' | 'inUse' | 'error' | 'updating' | 'deleting' | 'errorDeleting' | 'deleted': The volume status.
    - `Tags` Tag[]
      - `key` string: Key of the Tag object.
      - `Value` string: Value of the Tag object.
    - `SnapshotId` string: The volume snapshot id.
    - `Encrypted` boolean: Flag for encryted volume.
    - `EncryptedSettings` object: Encryted volume Keys.
    - `Metadata` object
      - `fields` VolumeFields
        - `CreationTimeAtBackend` object
          - `kind` object
            - `StringValue` string
        - `StartTimeAtBackend` object
          - `kind` object
            - `StringValue` string
        - `VolumeId` object
          - `kind` object
            - `StringValue` string
        - `Progress` object
          - `kind` object
            - `NumberValue` integer
  - `next` integer

---

[API](https://skmtc.dev/sodafoundation/apis/soda-crystal-api.md) - [All operations](https://skmtc.dev/sodafoundation/apis/soda-crystal-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sodafoundation/apis/soda-crystal-api/revisions/c02dd33a522b?raw)