OrganizationData

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.

post/api/organizations/{organizationId}/buckets/{bucketId}

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or OAuth 2
  Authorization code/v1/oauth/authorize
  Client credentials
  Implicit/v1/oauth/authorize
  Password
  Token URL/v1/oauth/token
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/organizations/:organizationId/buckets/:bucketId/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

organizationIdinteger required

Organization ID

bucketIdinteger required

Bucket ID

Request 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 request

{
  "storageAccountName": "my-storage-account"
}

Response

successboolean required

Whether the operation succeeded

errorstring

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

Changes

No recorded changes to this operation across all 1 revision of this API.