Documentation IndexFetch the complete documentation index at: /llms.txtUse this file to discover all available pages before exploring further.
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
cURL
curl --request GET \ --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/portals/{portalId} \ --header 'x-api-key: <api-key>'
import requests url = "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/portals/{portalId}" headers = {"x-api-key": "<api-key>"} response = requests.get(url, headers=headers) print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}}; fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/portals/{portalId}', options) .then(res => res.json()) .then(res => console.log(res)) .catch(err => console.error(err));
<?php $curl = curl_init(); curl_setopt_array($curl, [ CURLOPT_URL => "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/portals/{portalId}", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "x-api-key: <api-key>" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; }
package main import ( "fmt" "net/http" "io" ) func main() { url := "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/portals/{portalId}" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("x-api-key", "<api-key>") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(string(body)) }
HttpResponse<String> response = Unirest.get("https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/portals/{portalId}") .header("x-api-key", "<api-key>") .asString();
require 'uri' require 'net/http' url = URI("https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/portals/{portalId}") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["x-api-key"] = '<api-key>' response = http.request(request) puts response.read_body
{ "success": true, "id": 123, "name": "EdgeImpulse Inc.", "url": "edgeImpulse", "token": "SECRET_TOKEN", "bucketName": "my-s3-bucket", "bucketPath": "/path/to/bucket", "error": "<string>", "description": "EdgeImpulse Inc. Portal description", "bucketId": 1, "bucketUrl": "s3://bucketname/path/to/bucket", "storageProvider": "s3" }
Retrieve a single upload portals identified by ID.
Organization ID
Portal ID
OK
Whether the operation succeeded
Portal ID for the new upload portal
The name of the upload portal.
"EdgeImpulse Inc."
The url postfix of the upload portal.
"edgeImpulse"
The token used to validate access to the upload portal.
"SECRET_TOKEN"
The S3 bucket name to store the uploaded data.
"my-s3-bucket"
The S3 bucket path where uploaded data is stored.
"/path/to/bucket"
Optional error description (set if 'success' was false)
The purpose and description of the upload portal.
"EdgeImpulse Inc. Portal description"
S3 bucket ID. If missing, then this is using the Edge Impulse hosted bucket.
1
The full S3 bucket path where uploaded data is stored.
"s3://bucketname/path/to/bucket"
The storage provider type (s3, azure, google, other).
"s3"
Was this page helpful?