Verify bucket connectivity

Verify whether we can reach a bucket before adding it.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/verify

Path parameters

organizationId*integer

Organization ID

Body

accessKey*string

S3 access key

secretKey*string

S3 secret key

bucket*string

S3 bucket

endpoint*string

S3 endpoint

region*string

S3 region

prefixstring

Optional prefix in the bucket. Set this if you don't have access to the full bucket for example.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

files*array of object

20 random files from the bucket.

name*string

size*integer

folderName*string

hasInfoLabelsFile*boolean

Indicates whether there are any info.labels files in this bucket. If so, those are used for category/labels.

signedUrl*string

A signed URL that allows you to PUT an item, to check whether CORS headers are set up correctly for this bucket.

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/verify', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "accessKey": "text",
      "secretKey": "text",
      "endpoint": "text",
      "bucket": "text",
      "region": "text"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "files": [
    {
      "name": "text",
      "folderName": "text"
    }
  ],
  "hasInfoLabelsFile": false,
  "signedUrl": "text"
}