Verify bucket connectivity

curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/verify \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "storageProvider": "s3",
  "accessKey": "<string>",
  "secretKey": "<string>",
  "bucketId": 123,
  "bucket": "<string>",
  "endpoint": "<string>",
  "region": "<string>",
  "prefix": "<string>"
}'

{
  "success": true,
  "error": "<string>",
  "connectionStatus": "connected",
  "connectionError": "<string>",
  "connectionStatusSince": "2023-11-07T05:31:56Z",
  "files": [
    {
      "name": "<string>",
      "size": 123,
      "folderName": "<string>"
    }
  ],
  "hasInfoLabelsFile": true,
  "signedUrl": "<string>",
  "endpoint": "<string>"
}

OrganizationData

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.

POST

api

organizations

{organizationId}

buckets

verify

Verify bucket connectivity

curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/verify \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "storageProvider": "s3",
  "accessKey": "<string>",
  "secretKey": "<string>",
  "bucketId": 123,
  "bucket": "<string>",
  "endpoint": "<string>",
  "region": "<string>",
  "prefix": "<string>"
}'

{
  "success": true,
  "error": "<string>",
  "connectionStatus": "connected",
  "connectionError": "<string>",
  "connectionStatusSince": "2023-11-07T05:31:56Z",
  "files": [
    {
      "name": "<string>",
      "size": 123,
      "folderName": "<string>"
    }
  ],
  "hasInfoLabelsFile": true,
  "signedUrl": "<string>",
  "endpoint": "<string>"
}

Authorizations

x-api-key

string

header

required

Path Parameters

organizationId

integer

required

Organization ID

Body

application/json

Response

200 - application/json

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".

Add a storage bucket Get storage bucket

APIs

Studio API endpoints

Verify bucket connectivity

Authorizations

Path Parameters

Body

Response