Update upload portal

Update upload portal

put

Updates an upload portal for the organization.

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

Path parameters

organizationIdintegerRequired

Organization ID

portalIdintegerRequired

Portal ID

Body

namestringRequired

The name of the upload portal.

Example: EdgeImpulse Inc.

descriptionstringOptional

The purpose and description of the upload portal.

Example: EdgeImpulse Inc. Portal description

bucketIdintegerRequired

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

Example: 1

bucketPathstringRequired

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

Example: /path/in/bucket

Responses

200

OK

application/json

Responseall of

put

HTTPcURLJavaScriptPython

PUT /v1/api/organizations/{organizationId}/portals/{portalId}/update HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "name": "EdgeImpulse Inc.",
  "description": "EdgeImpulse Inc. Portal description",
  "bucketId": 1,
  "bucketPath": "/path/in/bucket"
}

200

OK

{
  "success": true,
  "error": "text",
  "url": "text",
  "signedUrl": "text",
  "bucketBucket": "text"
}