Add a storage bucket
Add a storage bucket.
Authorizations
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 · enumOptionalPossible values:
The type of storage provider. Defaults to 's3' if not specified.
Responses
200
OK
application/json
Responseall of
post
POST /v1/api/organizations/{organizationId}/buckets HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 145
{
"accessKey": "text",
"secretKey": "text",
"endpoint": "text",
"bucket": "text",
"region": "text",
"checkConnectivityPrefix": "text",
"storageProvider": "s3"
}
200
OK
{
"success": true,
"error": "text",
"id": 1
}
Last updated
Was this helpful?