# 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="/files/cu2UysyUZ5uqCo3o5K2T" 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](/cloudeka-api-list/global-flags.md). Refer to the Global Flags section for details.
{% endhint %}

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.cloudeka.ai/cloudeka-api-list/command-reference/cldkctl-box/bucket-list.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.