Sign in
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"
}

Changes

Changed in 7 of the 33 revisions of this API.23745

  • b348fb4e977f2015See the full diff
    • ●

      removed the request property Access

      request-property-removed

    • ●

      removed the request property BucketName

      request-property-removed

    • ●

      removed the request property Endpoint

      request-property-removed

    • ●

      removed the request property Id

      request-property-removed

    • ●

      removed the request property Name

      request-property-removed

    • ●

      removed the request property Region

      request-property-removed

    • ●

      removed the request property Security

      request-property-removed

    • ●

      removed the request property TenantId

      request-property-removed

    • ●

      removed the request property Type

      request-property-removed

    • ●

      removed the request property UserId

      request-property-removed

    • ●

      removed the optional property Access from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property BucketName from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property Endpoint from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property Id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property Name from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property Region from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property Security from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property TenantId from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property Type from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property UserId from the response with the 200 status

      response-optional-property-removed

    • ○

      added the new optional request property access

      new-optional-request-property

    • ○

      added the new optional request property endpoint

      new-optional-request-property

    • ○

      added the new optional request property name

      new-optional-request-property

    • ○

      added the new optional request property region

      new-optional-request-property

    • ○

      added the new optional request property security

      new-optional-request-property

    • ○

      added the new optional request property type

      new-optional-request-property

    • ○

      added the optional property access to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property endpoint to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property name to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property region to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property security to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property tenantId to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property type to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property userId to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 443f565555ae24See the full diff
    • ●

      added the new aws-file enum value to the Type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new azure-file enum value to the Type response property for the response status 200

      response-property-enum-value-added

    • ○

      api tag Backend added

      api-tag-added

    • ○

      api tag backend removed

      api-tag-removed

    • ○

      added the new aws-file enum value to the request property Type

      request-property-enum-value-added

    • ○

      added the new azure-file enum value to the request property Type

      request-property-enum-value-added

  • bec7a127bf7f1See the full diff
    • ○

      endpoint added

      endpoint-added

  • f9da14548ae51See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 56dbe50974ed1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • cf53a96f0da11See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 50fa096a39061524See the full diff
    • ●

      removed the request property access

      request-property-removed

    • ●

      removed the request property endpoint

      request-property-removed

    • ●

      removed the request property name

      request-property-removed

    • ●

      removed the request property region

      request-property-removed

    • ●

      removed the request property security

      request-property-removed

    • ●

      removed the request property type

      request-property-removed

    • ●

      removed the optional property access from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property endpoint from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property name from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property region from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property security from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property tenantId from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property type from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property userId from the response with the 200 status

      response-optional-property-removed

    • ○

      api tag backend added

      api-tag-added

    • ○

      api tag Backend removed

      api-tag-removed

    • ○

      added the new optional request property Access

      new-optional-request-property

    • ○

      added the new optional request property BucketName

      new-optional-request-property

    • ○

      added the new optional request property Endpoint

      new-optional-request-property

    • ○

      added the new optional request property Id

      new-optional-request-property

    • ○

      added the new optional request property Name

      new-optional-request-property

    • ○

      added the new optional request property Region

      new-optional-request-property

    • ○

      added the new optional request property Security

      new-optional-request-property

    • ○

      added the new optional request property TenantId

      new-optional-request-property

    • ○

      added the new optional request property Type

      new-optional-request-property

    • ○

      added the new optional request property UserId

      new-optional-request-property

    • ○

      removed the non-success response with the status 401

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 415

      response-non-success-status-removed

    • ○

      added the optional property Access to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property BucketName to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property Endpoint to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property Id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property Name to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property Region to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property Security to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property TenantId to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property Type to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property UserId to the response with the 200 status

      response-optional-property-added

    This revision also has 46 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 33 revisions, 3 have no diff computed.