Verify existing bucket connectivity

Verify existing bucket connectivity

post

Verify whether we can reach a bucket before adding it.

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

organizationIdintegerrequired

Organization ID

bucketIdintegerrequired

Bucket ID

Body

prefixstringrequired

Responses

application/json

all ofoptional

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

post

HTTPcURLJavaScriptPython

POST /v1/api/organizations/{organizationId}/buckets/{bucketId}/verify HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "prefix": "text"
}

200

OK

{
  "success": true,
  "error": "text",
  "connectionStatus": "connected",
  "connectionError": "text",
  "connectionStatusSince": "2025-04-16T14:30:36.449Z",
  "files": [
    {
      "name": "text",
      "size": 1,
      "folderName": "text"
    }
  ],
  "hasInfoLabelsFile": true,
  "signedUrl": "text",
  "endpoint": "text"
}