Add a storage bucket

Add a storage bucket

post

Add a storage bucket.

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

organizationIdintegerrequired

Organization ID

Body

accessKeystringrequired

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

secretKeystringrequired

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

endpointstringrequired

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

bucketstringrequired

Name of the storage bucket

regionstringrequired

Region of the storage service (if applicable)

checkConnectivityPrefixstringoptional

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

storageProviderstring · enumoptional

The type of storage provider. Defaults to 's3' if not specified.

Options: s3, google, azure, other

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "accessKey": "text",
    "secretKey": "text",
    "endpoint": "text",
    "bucket": "text",
    "region": "text",
    "checkConnectivityPrefix": "text",
    "storageProvider": "s3"
  }'

200

200

{
  "success": true,
  "error": "text",
  "id": 1
}

OK