Get Bucket List

Operation ID: getBucketList
Get the bucket list of the platform tenant

Request

URI

GET

https://{api_host}/api/v1/bucket-list

COPY

Query Parameters

string

tenant_id

Required

The ID of the tenant to get its bueckt list

integer

offset

Optional

The start index of buckets to return

integer

limit

Optional

The maximum number of buckets to return

Authentication

This operation uses the following authentication methods.

basicAuth

bearerAuth

Responses

200

The bucket list of the platform tenant is returned

Returns PageOfBucketMeta of type(s) application/json

{
    "page_info": {
        "total": 1,
        "offset": 6,
        "limit": 0
    },
    "items": [
        {
            "user_id": "user_id",
            "name": "name",
            "creation_date": "2000-01-23T04:56:07+00:00"
        },
        {
            "user_id": "user_id",
            "name": "name",
            "creation_date": "2000-01-23T04:56:07+00:00"
        }
    ]
}

array of OsisBucketMeta

items

Optional

items

PageInfo

page_info

Optional

page_info

501

The optional API is not implemented

Operation doesn't return any data structure

On This Page