---
title: "List all file shares."
method: GET
path: "/v1/{tenantId}/file/shares"
tags: ["FileShare"]
---

# List all file shares.

`GET /v1/{tenantId}/file/shares`

## Request

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

## Query parameters

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

## Response `200`

successful operation.

- object
  - `fileshares` FileShareResult[]
    - `Id` string: The fileshare ID, generated by server
    - `CreatedAt` string: The time of creation of the fileshare.
    - `UpdatedAt` string: The time at which the fileshare 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 fileshare name specified by user.
    - `Description` string: The fileshare description specified by user.
    - `Type` string: The fileshare type.
    - `Size` integer: The fileshare size.
    - `Region` string: The region for the fileshare.
    - `AvailabilityZone` string: The availability zone for the fileshare.
    - `Status` 'available' | 'creating' | 'inUse' | 'error' | 'updating' | 'deleting' | 'errorDeleting' | 'deleted': The fileshare status.
    - `Protocols` 'NFS' | 'SMB': The fileshare supported protocols.
    - `Tags` Tag[]
      - `key` string: Key of the Tag object.
      - `Value` string: Value of the Tag object.
    - `SnapshotId` string: The fileshare snapshot id.
    - `Encrypted` boolean: Flag for encryted fileshare.
    - `EncryptedSettings` object: Encryted fileshare Keys.
    - `Metadata` object
      - `fields` Fields
        - `CreationTimeAtBackend` object
          - `kind` object
            - `StringValue` string
        - `CreationToken` object
          - `kind` object
            - `StringValue` string
        - `FileSystemId` object
          - `kind` object
            - `StringValue` string
        - `FileSystemSize` object
          - `kind` object
            - `StructValue` object
              - …
        - `LifeCycleState` object
          - `kind` object
            - `StringValue` 'creating' | 'available' | 'updating' | 'deleting' | 'deleted'
        - `Name` object
          - `kind` object
            - `StringValue` string
        - `NumberOfMountTargets` object
          - `kind` object
            - `NumberValue` integer
        - `OwnerId` object
          - `kind` object
            - `StringValue` string
        - `PerformanceMode` object
          - `kind` object
            - `StringValue` 'generalPurpose' | 'maxIO'
        - `ProvisionedThroughputInMibps` object
          - `kind` object
            - `NumberValue` integer
        - `ThroughputMode` object
          - `kind` object
            - `StringValue` 'bursting' | 'provisioned'
  - `next` integer

## Other responses

- `401`: Unauthorized. Token not found in header

---

[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)