---
title: "GET /v1/disks"
method: GET
path: "/v1/disks"
tags: ["Disks"]
---

# GET /v1/disks

`GET /v1/disks`

## Request

- The document declares no server URL.
- Auth: none declared

List all disks.

## Query parameters

- `limit` integer
- `offset` integer
- `sort` string
- `name` string
- `id` string
- `native_disk_id` string
- `storage_id` string
- `native_disk_group_id` string
- `status` 'normal' | 'offline' | 'abnormal'

## Response `200`

List disk query was success

- object
  - `disks` DiskSpec[], required
    - `id` string, required
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `name` string, required
    - `storage_id` string
    - `native_disk_id` string
    - `serial_number` string
    - `manufacturer` string
    - `model` string
    - `firmware` string
    - `speed` integer
    - `capacity` integer
    - `location` string
    - `status` 'normal' | 'offline' | 'abnormal'
    - `physical_type` 'sata' | 'sas' | 'ssd' | 'nl-sas' | 'unknown'
    - `logical_type` 'free' | 'member' | 'hotspare' | 'cache'
    - `health_score` integer
    - `native_disk_group_id` string

## Other responses

- `401`: NotAuthorized
- `403`: Forbidden
- `500`: An unexpected error occured.

## Changes

- **2022-05-02** `160df40b1288`: 1 breaking, 1 info
  - removed the required property `ports` from the response with the `200` status
  - added the required property `disks` to the response with the `200` status
- **2021-03-12** `abba65e52027`: 1 warning, 1 info
  - removed the optional property `controllers` from the response with the `200` status
  - added the required property `ports` to the response with the `200` status
- **2020-12-18** `ca4c65fcc589`: 1 info
  - endpoint added
- **2020-06-22** `0fdcb8a77d6a`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/sodafoundation/apis/soda-infrastructure-management-api/changes/v1/disks/get.md)

---

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