Retrieve upload portal information

Retrieve upload portal information

Retrieve a single upload portals identified by ID.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/portals/{portalId}

Path parameters

organizationId*integer

Organization ID

portalId*integer

Portal ID

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Portal ID for the new upload portal

name*string

The name of the upload portal.

Example: "EdgeImpulse Inc."

descriptionstring

The purpose and description of the upload portal.

Example: "EdgeImpulse Inc. Portal description"

url*string

The url postfix of the upload portal.

Example: "edgeImpulse"

token*string

The token used to validate access to the upload portal.

Example: "SECRET_TOKEN"

bucketName*string

The S3 bucket name to store the uploaded data.

Example: "my-s3-bucket"

bucketIdinteger

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

Example: 1

bucketPath*string

The S3 bucket path where uploaded data is stored.

Example: "/path/to/bucket"

bucketUrlstring

The full S3 bucket path where uploaded data is stored.

Example: "s3://bucketname/path/to/bucket"

Request

JavaScriptCurlPython

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/portals/{portalId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "error": "text",
  "id": 0,
  "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"
}