Update storage bucket

curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/{bucketId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "accessKey": "<string>",
  "secretKey": "<string>",
  "endpoint": "<string>",
  "bucket": "<string>",
  "region": "<string>",
  "checkConnectivityPrefix": "<string>",
  "storageAccountName": "my-storage-account"
}'

{
  "success": true,
  "error": "<string>"
}

Update storage bucket

Updates storage bucket details. This only updates fields that were set in the request body. Before updating the bucket details, it is required to verify the connection using the POST /api/organizations//buckets/verify endpoint.

The verification process:

Call the verify endpoint with the new bucket details.
Poll the verify endpoint until it responds with connectionStatus: connected.
If the endpoint responds with connectionStatus: error, the verification has failed.

Only proceed with updating the bucket details after receiving a connected status. The polling interval and timeout should be determined based on your application’s requirements.

POST

api

organizations

{organizationId}

buckets

{bucketId}

Update storage bucket

curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/{bucketId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "accessKey": "<string>",
  "secretKey": "<string>",
  "endpoint": "<string>",
  "bucket": "<string>",
  "region": "<string>",
  "checkConnectivityPrefix": "<string>",
  "storageAccountName": "my-storage-account"
}'

{
  "success": true,
  "error": "<string>"
}

Authorizations

x-api-key

string

header

required

Path Parameters

organizationId

integer

required

Organization ID

bucketId

integer

required

Bucket ID

Body

application/json

accessKey

string

S3 access key

secretKey

string

S3 secret key

endpoint

string

S3 endpoint

bucket

string

S3 bucket

region

string

S3 region

checkConnectivityPrefix

string

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

storageAccountName

string

The name of the storage account for Azure Blob Storage

Example:

"my-storage-account"

Response

200 - application/json

success

boolean

required

Whether the operation succeeded

error

string

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

Get storage bucket

Remove storage bucket

OVERVIEW

STUDIO API ENDPOINTS

Update storage bucket

Authorizations

Path Parameters

Body

Response