---
title: "Create a backend."
method: POST
path: "/v1/{tenantId}/backends"
tags: ["Backend"]
---

# Create a backend.

`POST /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

## Request body

- BackendRequest
  - `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
  - `access` string
  - `security` string

## Response `200`

successful operation

- Backend
  - `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
  - `access` string
  - `security` string

## Other responses

- `401`: Unauthorized. Token not found in header
- `415`: Unsupported Media Type

## Changes

- **2025-01-08** `6517d105571e`: 2 breaking, 2 info
  - removed the enum value `ceph-s3` of the request property `type`
  - removed the enum value `hw-obs` of the request property `type`
  - removed the `ceph-s3` enum value from the `type` response property for the response status `200`
  - removed the `hw-obs` enum value from the `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 `type` response property for the response status `200`
  - added the new `hw-obs` enum value to the `type` response property for the response status `200`
  - added the new `ceph-s3` enum value to the request property `type`
  - added the new `hw-obs` enum value to the request property `type`

[Operation history](https://skmtc.dev/sodafoundation/apis/soda-crystal-api/changes/v1/:tenantId/backends/post.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)