Backend

Update a backend.

put/v1/{tenantId}/backends/{backendId}

Request body

accessstring

Updated the specified backend access Id

securitystring

Updated the specified backend security Id

Example request

{
  "access": "AMIKJGNJLHUEBWTNDL6X",
  "security": "Fsgs5KHAcs12420yGHNDGne8x8i5naHvdf/xZbTH"
}

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 4 of the 33 revisions of this API.11414

  • b348fb4e977f1211See the full diff
    • removed the request property

      request-property-removed

    • removed the request property

      request-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • added the new optional request property

      new-optional-request-property

    • added the new optional request property

      new-optional-request-property

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the 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

  • 443f565555ae22See the full diff
    • added the new aws-file enum value to the response property for the response status

      response-property-enum-value-added

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

      response-property-enum-value-added

    • api tag Backend added

      api-tag-added

    • api tag backend removed

      api-tag-removed

    • endpoint added

      endpoint-added

    • api removed without deprecation

      api-removed-without-deprecation

    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.