Interface ListBucketsRequest

Request parameters for the b2_list_buckets API call.

interface ListBucketsRequest {
    accountId: AccountId;
    bucketId?: BucketId;
    bucketName?: string;
    bucketTypes?: readonly BucketType[];
}

Index

Properties

accountId bucketId? bucketName? bucketTypes?

Properties

`Readonly`accountId

accountId: AccountId

Account whose buckets to list.

`Optional` `Readonly`bucketId

bucketId?: BucketId

Optional filter to return only the bucket with this ID.

`Optional` `Readonly`bucketName

bucketName?: string

Optional filter to return only the bucket with this name.

`Optional` `Readonly`bucketTypes

bucketTypes?: readonly BucketType[]

Optional filter to return only buckets of these types.