OrganizationData

Verify existing bucket connectivity

Verify whether we can reach a bucket before adding it.

post/api/organizations/{organizationId}/buckets/{bucketId}/verify

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or OAuth 2
  Authorization code/v1/oauth/authorize
  Client credentials
  Implicit/v1/oauth/authorize
  Password
  Token URL/v1/oauth/token
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/organizations/:organizationId/buckets/:bucketId/verify/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

organizationIdinteger required

Organization ID

bucketIdinteger required

Bucket ID

Request body

prefixstring required

Response

successboolean required

Whether the operation succeeded

errorstring

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

connectionStatus'connected' | 'connecting' | 'error' required

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.

connectionErrorstring nullable

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

connectionStatusSincestring date-time nullable

Timestamp of when the connectionStatus last changed.

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.

Changes

No recorded changes to this operation across all 1 revision of this API.