Add a storage bucket

Add a storage bucket

Add a storage bucket.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets

Path parameters

organizationId*integer

Organization ID

Body

application/json

accessKey*string

Access key for the storage service (e.g., S3 access key, GCS access key)

secretKey*string

Secret key for the storage service (e.g., S3 secret key, GCS secret key)

endpoint*string

Endpoint URL for the storage service (e.g., S3 endpoint, custom endpoint for other services)

bucket*string

Name of the storage bucket

region*string

Region of the storage service (if applicable)

checkConnectivityPrefixstring

Set this if you don't have access to the root of this bucket. Only used to verify connectivity to this bucket.

storageProviderStorageProvider (enum)

s3googleazureother

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Unique identifier of the created entity.

Request

JavaScriptCurlPython

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "accessKey": "text",
      "secretKey": "text",
      "endpoint": "text",
      "bucket": "text",
      "region": "text"
    }),
});
const data = await response.json();

Response

200

{
  "success": false,
  "error": "text",
  "id": 0
}