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

OK

Response object for verifying an organization's bucket connectivity.

Workflow:

  1. The client initiates verification by sending a GET request to /api/organizations/{organizationId}/buckets/verify with bucket and credential details.
  2. The server responds with this VerifyOrganizationBucketResponse object.
  3. 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.
  4. If connectionStatus is "connecting", the client should periodically poll the endpoint until the status changes to "connected" or "error".