Backend

List all backends.

get/v1/{tenantId}/backends

Query parameters

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

Filter the backend by backend type.

namestring

Filter the backend by name.

regionstring

Filter the backend by region.

offsetinteger

The number of items to skip before starting to collect the result set

limitinteger

The numbers of items to return

sortstring

The sort key and direction of items to return, string must like:"id:asc,name:desc"

Response

successful operation.

nextinteger

Example response

{
  "backends": [
    {
      "id": "5ea809d2553b0f000116be32",
      "tenantId": "94b280022d0c4401bcf3b0ea85870519",
      "userId": "558057c4256545bd8a307c37464003c9",
      "name": "backend001",
      "type": "aws-s3",
      "region": "ap-south-1",
      "endpoint": "s3.ap-south-1.amazonaws.com"
    }
  ],
  "next": 1
}

Changes

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

  • b348fb4e977f107See the full diff
    • removed the optional property backends/items/Access from the response with the 200 status

      response-optional-property-removed

    • removed the optional property backends/items/BucketName from the response with the 200 status

      response-optional-property-removed

    • removed the optional property backends/items/Endpoint from the response with the 200 status

      response-optional-property-removed

    • removed the optional property backends/items/Id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property backends/items/Name from the response with the 200 status

      response-optional-property-removed

    • removed the optional property backends/items/Region from the response with the 200 status

      response-optional-property-removed

    • removed the optional property backends/items/Security from the response with the 200 status

      response-optional-property-removed

    • removed the optional property backends/items/TenantId from the response with the 200 status

      response-optional-property-removed

    • removed the optional property backends/items/Type from the response with the 200 status

      response-optional-property-removed

    • removed the optional property backends/items/UserId from the response with the 200 status

      response-optional-property-removed

    • added the optional property backends/items/endpoint to the response with the 200 status

      response-optional-property-added

    • added the optional property backends/items/id to the response with the 200 status

      response-optional-property-added

    • added the optional property backends/items/name to the response with the 200 status

      response-optional-property-added

    • added the optional property backends/items/region to the response with the 200 status

      response-optional-property-added

    • added the optional property backends/items/tenantId to the response with the 200 status

      response-optional-property-added

    • added the optional property backends/items/type to the response with the 200 status

      response-optional-property-added

    • added the optional property backends/items/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 backends/items/Type response property for the response status 200

      response-property-enum-value-added

    • added the new azure-file enum value to the backends/items/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 enum value aws-file to the query request parameter type

      request-parameter-enum-value-added

    • added the new enum value azure-file to the query request parameter type

      request-parameter-enum-value-added

    • endpoint added

      endpoint-added

    • 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

    • 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

    • 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

  • 50fa096a39067713See the full diff
    • removed the enum value aws-file from the query request parameter type

      request-parameter-enum-value-removed

    • removed the enum value azure-file from the query request parameter type

      request-parameter-enum-value-removed

    • removed the enum value ceph-s3 from the query request parameter type

      request-parameter-enum-value-removed

    • removed the enum value fusionstorage-object from the query request parameter type

      request-parameter-enum-value-removed

    • removed the enum value gcp-s3 from the query request parameter type

      request-parameter-enum-value-removed

    • removed the enum value ibm-cos from the query request parameter type

      request-parameter-enum-value-removed

    • removed the enum value yig from the query request parameter type

      request-parameter-enum-value-removed

    • removed the optional property backends/items/endpoint from the response with the 200 status

      response-optional-property-removed

    • removed the optional property backends/items/id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property backends/items/name from the response with the 200 status

      response-optional-property-removed

    • removed the optional property backends/items/region from the response with the 200 status

      response-optional-property-removed

    • removed the optional property backends/items/tenantId from the response with the 200 status

      response-optional-property-removed

    • removed the optional property backends/items/type from the response with the 200 status

      response-optional-property-removed

    • removed the optional property backends/items/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

    • removed the non-success response with the status 401

      response-non-success-status-removed

    • added the optional property backends/items/Access to the response with the 200 status

      response-optional-property-added

    • added the optional property backends/items/BucketName to the response with the 200 status

      response-optional-property-added

    • added the optional property backends/items/Endpoint to the response with the 200 status

      response-optional-property-added

    • added the optional property backends/items/Id to the response with the 200 status

      response-optional-property-added

    • added the optional property backends/items/Name to the response with the 200 status

      response-optional-property-added

    • added the optional property backends/items/Region to the response with the 200 status

      response-optional-property-added

    • added the optional property backends/items/Security to the response with the 200 status

      response-optional-property-added

    • added the optional property backends/items/TenantId to the response with the 200 status

      response-optional-property-added

    • added the optional property backends/items/Type to the response with the 200 status

      response-optional-property-added

    • added the optional property backends/items/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.