OrganizationData

Add a storage bucket

Add a storage bucket.

post/api/organizations/{organizationId}/buckets

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/post.ts
A function with typed inputs. Its response is checked against the schema.

organizationIdinteger required

Organization ID

accessKeystring required

Access key for the storage service (e.g., S3 access key, GCS access key)

secretKeystring required

Secret key for the storage service (e.g., S3 secret key, GCS secret key)

endpointstring required

Endpoint URL for the storage service (e.g., S3 endpoint, custom endpoint for other services)

bucketstring required

Name of the storage bucket

regionstring required

Region of the storage service (if applicable)

checkConnectivityPrefixstring

Set this if you don't have access to the root of this bucket. Only used to verify connectivity to this bucket.

successboolean required

Whether the operation succeeded

errorstring

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

idinteger required

Unique identifier of the created entity.

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