Update upload portal

Updates an upload portal for the organization.

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

Path parameters

organizationId*integer

Organization ID

portalId*integer

Portal ID

Body

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"

bucketId*integer

The S3 bucket id to store the uploaded data. Set to '0' to select a bucket hosted by Edge Impulse.

Example: 1

bucketPath*string

The path in the bucket the upload portal will write to.

Example: "/path/in/bucket"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

url*string

URL to the portal

signedUrlstring

pre-signed upload URL, only set if not using the Edge Impulse hosted bucket.

bucketBucketstring

Only set if not using the Edge Impulse hosted bucket.

Request

Response

PreviousCreate upload portal NextRotate upload portal token

Last updated 8 months ago

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/portals/{portalId}/update', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "EdgeImpulse Inc.",
      "bucketId": 1,
      "bucketPath": "/path/in/bucket"
    }),
});
const data = await response.json();