Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-17524793.1 KB
Backend

Create a backend.

post/v1/{tenantId}/backends

Request body

namestring

The backend name specified by user.

type'hw-obs' | 'aws-s3' | 'azure-blob' | 'ceph-s3' | 'gcp-s3' | 'fusionstorage-object' | 'ibm-cos' | 'yig' | 'aws-file' | 'azure-file'

The backend type.

regionstring
endpointstring
accessstring
securitystring

Example request

{
  "name": "backend001",
  "type": "aws-s3",
  "region": "ap-south-1",
  "endpoint": "s3.ap-south-1.amazonaws.com",
  "access": "4X7JQDFTCYUNWFBRYZVC",
  "security": "9hr0ekZgg0vZHulEekTVfWuu1lnPFvpVAJQNHXdn"
}

Response

successful operation

idstring

The backend ID, generated by server

tenantIdstring

The tenant UUID in a multi-tenancy environment.

userIdstring

The user UUID in a multi-tenancy environment.

namestring

The backend name specified by user.

type'hw-obs' | 'aws-s3' | 'azure-blob' | 'ceph-s3' | 'gcp-s3' | 'fusionstorage-object' | 'ibm-cos' | 'yig' | 'aws-file' | 'azure-file'

The backend type.

regionstring
endpointstring
accessstring
securitystring

Example response

{
  "id": "5ea809d2553b0f000116be32",
  "tenantId": "94b280022d0c4401bcf3b0ea85870519",
  "userId": "558057c4256545bd8a307c37464003c9",
  "name": "backend001",
  "type": "aws-s3",
  "region": "ap-south-1",
  "endpoint": "s3.ap-south-1.amazonaws.com",
  "access": "4X7JQDFTCYUNWFBRYZVC",
  "security": "9hr0ekZgg0vZHulEekTVfWuu1lnPFvpVAJQNHXdn"
}