List storage buckets

Retrieve all configured storage buckets. This does not list the secret key.

GET /api/organizations/{organizationId}/buckets

Try it

List storage buckets

cURL

curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets \
  --header 'x-api-key: <api-key>'

200

{
  "success": true,
  "buckets": [
    {
      "id": 1,
      "accessKey": "AKIAIOSFODNN7EXAMPLE",
      "endpoint": "https://s3.amazonaws.com",
      "bucket": "my-organization-bucket",
      "region": "us-west-2",
      "connected": true,
      "storageProvider": "s3",
      "checkConnectivityPrefix": "data/",
      "storageAccountName": "my-storage-account"
    }
  ],
  "error": "<string>"
}

Authorizations

x-api-key · string · header · required

Path Parameters

organizationId · integer · required

Organization ID

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

buckets · object[] · required

Show child attributes

buckets. id · integer · required

Example:

1

buckets. accessKey · string · required

Access key for the storage service

Example:

"AKIAIOSFODNN7EXAMPLE"

buckets. endpoint · string · required

Endpoint URL for the storage service

Example:

"https://s3.amazonaws.com"

buckets. bucket · string · required

Name of the storage bucket

Example:

"my-organization-bucket"

buckets. region · string · required

Region of the storage service (if applicable)

Example:

"us-west-2"

buckets. connected · boolean · required

Whether we can reach the bucket

Example:

true

buckets. storageProvider · enum<string> · required

The type of storage provider for this bucket

Available options: s3, google, azure, other

Example:

"s3"

buckets. checkConnectivityPrefix · string

Optional prefix used for connectivity verification when root bucket access is restricted.

Example:

"data/"

buckets. storageAccountName · string

The name of the storage account for Azure Blob Storage

Example:

"my-storage-account"

error · string

Optional error description (set if 'success' was false)