Get buckets

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

GEThttps://studio.edgeimpulse.com/v1/api/users/{userId}/buckets

Path parameters

userId*integer

User ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

buckets*array of object

id*integer

organizationId*integer

organizationName*string

bucket*string

S3 bucket

region*string

S3 region

whitelabelId*integer

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

Request

Response

Get buckets

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

GEThttps://studio.edgeimpulse.com/v1/api/users/{userId}/buckets

Path parameters

userId*integer

User ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

buckets*array of object

id*integer

organizationId*integer

organizationName*string

bucket*string

S3 bucket

region*string

S3 region

whitelabelId*integer

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

Request

Response

const response = await fetch('https://studio.edgeimpulse.com/v1/api/users/{userId}/buckets', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "success": false,
  "error": "text",
  "buckets": [
    {
      "id": 0,
      "organizationId": 0,
      "organizationName": "text",
      "bucket": "text",
      "region": "text",
      "whitelabelId": 0
    }
  ]
}