# bucket-list

The box bucket-list command displays all buckets within a specific object storage instance.This command provides details such as bucket ID, name, region, S3 URL, and site configuration

## Usage

```
cldkctl box bucket-list [flags]
```

## Aliases

```
bucket-list, bucket-ls
```

## Steps

Follow the steps below to run and view the result of this command:

1. View your available object storage instances to find the Object Storage ID. Refer to the Box List section.
2. Run the following command in your terminal:

```
cldkctl box bucket-list <object-storage-id>
```

3. Replace `<object-storage-id>` with the ID of the object storage where you want to view all buckets.
4. Once executed successfully, the terminal displays a table of existing buckets.

<figure><img src="https://2882153758-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi9YWb69HFXLHYlXffReU%2Fuploads%2FRpA051DiQyKr9G63ZQwZ%2Funknown.png?alt=media&#x26;token=89e23c3c-94c4-4375-b11b-ee97078aa9ad" alt=""><figcaption></figcaption></figure>

| Column | Decription                       |
| ------ | -------------------------------- |
| ID     | Unique bucket identifier.        |
| Name   | Name of the bucket.              |
| Region | Region where the bucket resides. |
| S3 URL | URL for accessing the bucket.    |
| Site   | Storage site configuration.      |

## Flags

{% hint style="info" %}
This command supports [global flags](https://docs.cloudeka.ai/cloudeka-api-list/global-flags). Refer to the Global Flags section for details.
{% endhint %}

| Flag       | Description                       |
| ---------- | --------------------------------- |
| -h, --help | Help for box bucket-list command. |