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

# List all backends.

`GET /v1/{tenantId}/backends`

## Request

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

## Query parameters

- `type` 'aws-s3' | 'azure-blob' | 'gcp-s3' | 'fusionstorage-object' | 'ibm-cos' | 'yig' | 'aws-file' | 'azure-file'
- `name` string
- `region` string
- `offset` integer
- `limit` integer
- `sort` string

## Response `200`

successful operation.

- object
  - `backends` BackendList[]
    - `id` string: The backend ID, generated by server
    - `tenantId` string: The tenant UUID in a multi-tenancy environment.
    - `userId` string: The user UUID in a multi-tenancy environment.
    - `name` string: The backend name specified by user.
    - `type` 'aws-s3' | 'azure-blob' | 'gcp-s3' | 'fusionstorage-object' | 'ibm-cos' | 'yig' | 'aws-file' | 'azure-file': The backend type.
    - `region` string
    - `endpoint` string
  - `next` integer

## Other responses

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

## Changes

- **2025-01-08** `6517d105571e`: 2 breaking, 2 info
  - removed the enum value `ceph-s3` from the `query` request parameter `type`
  - removed the enum value `hw-obs` from the `query` request parameter `type`
  - removed the `ceph-s3` enum value from the `backends/items/type` response property for the response status `200`
  - removed the `hw-obs` enum value from the `backends/items/type` response property for the response status `200`
- **2023-09-17** `d4f502a59e17`: 2 warning, 2 info
  - added the new `ceph-s3` enum value to the `backends/items/type` response property for the response status `200`
  - added the new `hw-obs` enum value to the `backends/items/type` response property for the response status `200`
  - added the new enum value `ceph-s3` to the `query` request parameter `type`
  - added the new enum value `hw-obs` to the `query` request parameter `type`

[Operation history](https://skmtc.dev/sodafoundation/apis/soda-crystal-api/changes/v1/:tenantId/backends/get.md)

---

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