Create upload portal
Creates a new upload portal for the organization.
Authorizations
Path parameters
organizationIdintegerRequired
Organization ID
Body
namestringRequiredExample:
The name of the upload portal.
EdgeImpulse Inc.
descriptionstringOptionalExample:
The purpose and description of the upload portal.
EdgeImpulse Inc. Portal description
bucketIdintegerRequiredExample:
The S3 bucket id to store the uploaded data. Set to '0' to select a bucket hosted by Edge Impulse.
1
bucketPathstringRequiredExample:
The path in the bucket the upload portal will write to.
/path/in/bucket
Responses
200
OK
application/json
Responseall of
post
POST /v1/api/organizations/{organizationId}/portals/create 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",
"id": 1,
"url": "text",
"signedUrl": "text",
"bucketBucket": "text"
}
Last updated
Was this helpful?