Update storage bucket

Update storage bucket

post

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:

1. Call the verify endpoint with the new bucket details.
2. Poll the verify endpoint until it responds with connectionStatus: connected.
3. 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.

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

Path parameters

organizationIdintegerRequired

Organization ID

bucketIdintegerRequired

Bucket ID

Body

accessKeystringOptional

S3 access key

secretKeystringOptional

S3 secret key

endpointstringOptional

S3 endpoint

bucketstringOptional

S3 bucket

regionstringOptional

S3 region

checkConnectivityPrefixstringOptional

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

storageAccountNamestringOptional

The name of the storage account for Azure Blob Storage

Example: my-storage-account

Responses

200

OK

application/json

post

HTTPcURLJavaScriptPython

POST /v1/api/organizations/{organizationId}/buckets/{bucketId} HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "accessKey": "text",
  "secretKey": "text",
  "endpoint": "text",
  "bucket": "text",
  "region": "text",
  "checkConnectivityPrefix": "text",
  "storageAccountName": "my-storage-account"
}

200

OK

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