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.
Body
The type of storage backend to use. Supported options are:
- 's3': Amazon S3
- 'google': Google Cloud Storage
- 'azure': Azure Blob Storage
- 'huggingface': Hugging Face S3-compatible storage
- 'other': Other S3-compatible storage If not specified, defaults to 's3'
s3, google, azure, other, edgeimpulse, huggingface Response
OK
Response object for verifying an organization's bucket connectivity.
Workflow:
- The client initiates verification by sending a GET request to /api/organizations/{organizationId}/buckets/verify with bucket and credential details.
- The server responds with this VerifyOrganizationBucketResponse object.
- The client checks the connectionStatus:
- If "connected": Verification is complete. Other properties (files, hasInfoLabelsFile, signedUrl) are available.
- If "connecting": Verification is in progress. The client should continue polling. Other properties are not yet available.
- If "error": Verification failed. Check connectionError for details. Other properties are not available.
- If connectionStatus is "connecting", the client should periodically poll the endpoint until the status changes to "connected" or "error".
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.
connected, connecting, error