---
title: "GET /v1/shares"
method: GET
path: "/v1/shares"
tags: ["Shares"]
---

# GET /v1/shares

`GET /v1/shares`

## Request

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

List all shares.

## Query parameters

- `limit` integer
- `offset` integer
- `sort` string
- `name` string
- `id` string
- `native_share_id` string
- `native_filesystem_id` string
- `native_qtree_id` string
- `storage_id` string
- `protocol` 'cifs' | 'nfs' | 'ftp' | 'hdfs'

## Response `200`

List share query was success

- object
  - `shares` ShareSpec[], required
    - `id` string, required
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `name` string, required
    - `storage_id` string
    - `native_share_id` string
    - `native_filesystem_id` string
    - `native_qtree_id` string
    - `protocol` 'cifs' | 'nfs' | 'ftp' | 'hdfs'
    - `path` string

## Other responses

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

## Changes

- **2021-03-12** `abba65e52027`: 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/shares/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)
