Get buckets current user

List all organizational storage buckets that the current user has access to. This function is only available through a JWT token.

GET /api/users/buckets

Try it

Get buckets current user

cURL

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

200

{
  "success": true,
  "buckets": [
    {
      "id": 123,
      "organizationId": 123,
      "organizationName": "<string>",
      "bucket": "<string>",
      "region": "<string>",
      "whitelabelId": 123
    }
  ],
  "error": "<string>"
}

Authorizations

x-api-key · string · header · required

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

buckets · object[] · required

Show child attributes

buckets. id · integer · required

buckets. organizationId · integer · required

buckets. organizationName · string · required

buckets. bucket · string · required

S3 bucket

buckets. region · string · required

S3 region

buckets. whitelabelId · integer · required

The unique identifier of the white label this bucket belongs to, if any

error · string

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