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/{organizationId}/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.

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

Path parameters

organizationId*integer

Organization ID

bucketId*integer

Bucket ID

Body

accessKeystring

S3 access key

secretKeystring

S3 secret key

endpointstring

S3 endpoint

bucketstring

S3 bucket

regionstring

S3 region

checkConnectivityPrefixstring

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

storageAccountNamestring

The name of the storage account for Azure Blob Storage

Example: "my-storage-account"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response