---
title: "List Volumes"
method: GET
path: "/api/v1/extension/volumes"
tags: ["Extension"]
---

# List Volumes

`GET /api/v1/extension/volumes`

List Volumes

## Query parameters

- `limit` integer, nullable — Requests a page size of items. Returns a number of items up to a limit value.
- `marker` string, nullable — The ID of the last-seen item.
- `sort_dirs` 'desc' | 'asc'
- `sort_keys` VolumeSortKey[], nullable — Indicates in which attributes to sort. Updated_at is used as deleted_at
- `all_projects` boolean, nullable — List volumes for all projects.
- `project_id` string, nullable — Filter the list of volumes by the given project ID.
- `name` string, nullable — Filter the list of volumes by the given server name.
- `multiattach` boolean, nullable — Filter the list of volumes by the given multiattach.
- `status` 'creating' | 'available' | 'reserved' | 'attaching' | 'detaching' | 'in-use' | 'maintenance' | 'deleting' | 'awaiting-transfer' | 'error' | 'error_deleting' | 'backing-up' | 'restoring-backup' | 'error_backing-up' | 'error_restoring' | 'error_extending' | 'downloading' | 'uploading' | 'retyping' | 'extending'
- `bootable` boolean, nullable — Filter the list of volumes by the given bootable.
- `uuid` string[], nullable — Filter the list of volumes by the given volumes UUID.

## Headers

- `X-Openstack-Request-Id` string

## Response `200`

OK

- VolumesResponse
  - `count` integer, nullable — Count of volumes
  - `volumes` VolumesResponseBase[], required — Volumes list
    - `id` string, uuid4, required — Volume ID
    - `origin_data` object, required — The origin_data is the same like the response of https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=list-accessible-volumes-with-details-detail#list-accessible-volumes-with-details
    - `project_name` string, nullable — Project name
    - `attachments` VolumeAttachment[], nullable — Volume attachments
      - `id` string, required — Volume attachment id
      - `device` string, nullable — Device name
      - `server_id` string, nullable — Server id
      - `server_name` string, nullable — Server name
    - `name` string, nullable, required — Will be removed, please use origin_data[name]
    - `project_id` string, nullable, required — Will be removed, please use origin_data[os-vol-tenant-attr:tenant_id]
    - `host` string, nullable, required — Will be removed, please use origin_data[os-vol-host-attr:host]
    - `snapshot_id` string, nullable, required — Will be removed, please use origin_data[snapshot_id]
    - `source_volid` string, nullable, required — Will be removed, please use origin_data[source_volid]
    - `size` integer, nullable, required — Will be removed, please use origin_data[size]
    - `status` string, nullable, required — Will be removed, please use origin_data[status]
    - `volume_type` string, nullable, required — Will be removed, please use origin_data[volume_type]
    - `encrypted` boolean, nullable, required — Will be removed, please use origin_data[encrypted]
    - `bootable` string, nullable, required — Will be removed, please use origin_data[bootable]
    - `multiattach` boolean, nullable, required — Will be removed, please use origin_data[multiattach]
    - `availability_zone` string, nullable, required — Will be removed, please use origin_data[availability_zone]
    - `created_at` string, nullable, required — Will be removed, please use origin_data[created_at]

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `422` — Validation Error
- `500` — Internal Server Error

---

[API](https://skmtc.dev/openstack/apis/skyline-api.md) · [All operations](https://skmtc.dev/openstack/apis/skyline-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/openstack/skyline-api/revisions/4b7c0ce8c025/schema)