Verify bucket connectivity

Verify connectivity to a storage bucket and optionally list its contents. This endpoint allows you to:

Check if the provided bucket credentials are valid and the bucket is accessible.
Optionally list files in the bucket up to a specified limit.
Validate the bucket configuration before adding it to the organization.

The request can include details such as the bucket name, region, credentials, and listing options. The response provides information about the bucket's accessibility and, if requested, a list of files in the bucket.

Important note on verification process:

For S3-compatible storage backends: Verification is expected to be immediate.
For Azure buckets: Verification takes longer. Users are required to poll this endpoint until the connectionStatus changes from 'connecting' to 'connected'.

When dealing with Azure buckets, implement a polling mechanism to check the status periodically until it's confirmed as connected.

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

Path parameters

organizationId*integer

Organization ID

Body

storageProviderStorageProvider (enum)

s3googleazureother

accessKey*string

Access key for the storage service:

For S3 and GCS: Use the access key.
For Azure: Use the Storage Account Name.

secretKeystring

Secret key for the storage service:

For S3 and GCS: Use the secret key.
For Azure: Use the Storage Account Access Key. Note: You should either pass a secretKey value or a bucketId value.

bucketIdinteger

ID of an existing bucket. If provided, the credentials from this bucket will be used unless overridden by the secretKey property.

bucket*string

Name of the storage bucket or container.

endpoint*string

Endpoint URL for the storage service. For S3-compatible services, Azure, or custom endpoints.

regionstring

Optional region of the storage service (if applicable).

prefixstring

Optional prefix within the bucket. Set this if you don't have access to the full bucket or want to limit the scope.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

connectionStatus*enum

Indicates the current state of the connectivity verification process.

"connected": Verification successful, other properties are available.
"connecting": Verification in progress, continue polling.
"error": Verification failed, check connectionError for details.

connectedconnectingerror

connectionErrornullable string

Provides additional details if connectionStatus is "error". Helps diagnose verification failures.

connectionStatusSincenullable string (date-time)

Timestamp of when the connectionStatus last changed.

filesarray of object

Random files from the bucket. Only available when connectionStatus is "connected".

hasInfoLabelsFileboolean

Indicates whether there are any info.labels files in this bucket. If so, those are used for category/labels. Only available when connectionStatus is "connected".

signedUrlstring

A signed URL that allows you to PUT an item, to check whether CORS headers are set up correctly for this bucket. Only available when connectionStatus is "connected".

endpointstring

An alternative endpoint URL. Only returned and required for Azure storage accounts, where the endpoint must be reformatted. This field will be undefined for other storage providers.

Request