OpenIntegrations/docs/en/md/S3/Buckets-management/List-buckets.mdx

---
sidebar_position: 12
description: List buckets and other functions to work with S3 in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, S3]
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# List buckets
 Gets a list of buckets. It is possible to use filters if they are provided by your service



`Function ListBuckets(Val BasicData, Val Prefix = "", Val Region = "", Val PageToken = "", Val Headers = Undefined) Export`

  | Parameter | CLI option | Type | Required | Description |
  |-|-|-|-|-|
  | BasicData | --basic | Structure Of KeyAndValue | ✔ | Basic request data. See GetBasicDataStructure |
  | Prefix | --prefix | String | ✖ | Filtering by prefix, if necessary |
  | Region | --region | String | ✖ | Selection by bucket region, if necessary |
  | PageToken | --ctoken | String | ✖ | Page token if pagination is used |
  | Headers | --headers | Map Of KeyAndValue | ✖ | Additional request headers, if necessary |

  
  Returns:  Structure Of KeyAndValue - serialized JSON response from storage

<br/>

:::tip
Method at AWS documentation: [ListBuckets](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html)
:::
<br/>



```bsl title="1C:Enterprise/OneScript code example"
    URL       = "storage-155.s3hoster.by";
    AccessKey = "BRN5RKJE67...";
    SecretKey = "NNhv+i9PrytpT8Tu0C1N...";
    Region    = "BTC";

    BasicData = OPI_S3.GetBasicDataStructure(URL, AccessKey, SecretKey, Region);
    Result    = OPI_S3.ListBuckets(BasicData);
```
 

 <Tabs>
  
    <TabItem value="bash" label="Bash" default>
        ```bash
            # JSON data can also be passed as a path to a .json file
            
            oint s3 ListBuckets \
             --basic "{'URL':'storage-155.s3hoster.by','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3'}"
        ```
    </TabItem>
  
    <TabItem value="bat" label="CMD/Bat" default>
        ```batch
            :: JSON data can also be passed as a path to a .json file
            
            oint s3 ListBuckets ^
             --basic "{'URL':'storage-155.s3hoster.by','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3'}"
        ```
    </TabItem>
</Tabs>


```json title="Result"
{
 "status": 200,
 "response": {
  "ListAllMyBucketsResult": {
   "Owner": {
    "ID": "02d6176db174dc93cb1b899f7c6078f08654445fe8cf1b6ce98d8855f66bdbf4",
    "DisplayName": "minio"
   },
   "Buckets": {
    "Bucket": [
     {
      "Name": "newbucket2",
      "CreationDate": "2024-11-13T18:59:09.139Z"
     },
     {
      "Name": "opi-dirbucket3",
      "CreationDate": "2024-11-22T10:11:56.477Z"
     },
     {
      "Name": "opi-gpbucket3",
      "CreationDate": "2024-11-22T10:11:56.771Z"
     },
     {
      "Name": "opi-newbucket2",
      "CreationDate": "2024-11-14T06:04:12.769Z"
     }
    ]
   }
  }
 },
 "headers": {
  "Accept-Ranges": "bytes",
  "Content-Length": "658",
  "Content-Type": "application/xml",
  "Date": "Fri, 22 Nov 2024 10:11:56 GMT",
  "Server": "MinIO",
  "Strict-Transport-Security": "max-age=31536000; includeSubDomains",
  "Vary": "Origin,Accept-Encoding",
  "X-Amz-Id-2": "e602da57d0c30b8c7034fcfe129917205f80f7bab979408e71da5d1441c85e79",
  "X-Amz-Request-Id": "180A42ACDE729B34",
  "X-Content-Type-Options": "nosniff",
  "X-Xss-Protection": "1; mode=block"
 }
}
```