EDedgeimpulse
OrganizationPortals

Retrieve upload portal information

Retrieve a single upload portals identified by ID.

get/api/organizations/{organizationId}/portals/{portalId}

Request

Path parameters

organizationIdinteger required

Organization ID

portalIdinteger required

Portal ID

Response

OK

successboolean required

Whether the operation succeeded

errorstring

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

idinteger required

Portal ID for the new upload portal

namestring required

The name of the upload portal.

descriptionstring

The purpose and description of the upload portal.

urlstring required

The url postfix of the upload portal.

tokenstring required

The token used to validate access to the upload portal.

bucketNamestring required

The S3 bucket name to store the uploaded data.

bucketIdinteger

S3 bucket ID. If missing, then this is using the Edge Impulse hosted bucket.

bucketPathstring required

The S3 bucket path where uploaded data is stored.

bucketUrlstring

The full S3 bucket path where uploaded data is stored.

storageProviderstring

The storage provider type (s3, azure, google, other).

Example response

{
  "name": "EdgeImpulse Inc.",
  "description": "EdgeImpulse Inc. Portal description",
  "url": "edgeImpulse",
  "token": "SECRET_TOKEN",
  "bucketName": "my-s3-bucket",
  "bucketId": 1,
  "bucketPath": "/path/to/bucket",
  "bucketUrl": "s3://bucketname/path/to/bucket",
  "storageProvider": "s3"
}

Changes

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