OrganizationData

List storage buckets

Retrieve all configured storage buckets. This does not list the secret key.

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

Path parameters

organizationIdinteger required

Organization ID

Response

successboolean required

Whether the operation succeeded

errorstring

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

Example response

{
  "buckets": [
    {
      "id": 1,
      "accessKey": "AKIAIOSFODNN7EXAMPLE",
      "endpoint": "https://s3.amazonaws.com",
      "bucket": "my-organization-bucket",
      "region": "us-west-2",
      "connected": true,
      "checkConnectivityPrefix": "data/",
      "storageAccountName": "my-storage-account"
    }
  ]
}

Changes

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