Get storage bucket

Get storage bucket details.

GET /api/organizations/{organizationId}/buckets/{bucketId}

Try it

Get storage bucket

cURL

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

200

{
  "success": true,
  "bucket": {
    "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

bucketId · integer · required

Bucket ID

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

bucket · object · required

Show child attributes

bucket. id · integer · required

Example:

1

bucket. accessKey · string · required

Access key for the storage service

Example:

"AKIAIOSFODNN7EXAMPLE"

bucket. endpoint · string · required

Endpoint URL for the storage service

Example:

"https://s3.amazonaws.com"

bucket. bucket · string · required

Name of the storage bucket

Example:

"my-organization-bucket"

bucket. region · string · required

Region of the storage service (if applicable)

Example:

"us-west-2"

bucket. connected · boolean · required

Whether we can reach the bucket

Example:

true

bucket. storageProvider · enum<string> · required

The type of storage provider for this bucket

Available options: s3, google, azure, other

Example:

"s3"

bucket. checkConnectivityPrefix · string

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

Example:

"data/"

bucket. 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)