Update storage bucket
curl --request POST \
--url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/{bucketId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"accessKey": "<string>",
"secretKey": "<string>",
"endpoint": "<string>",
"bucket": "<string>",
"region": "<string>",
"checkConnectivityPrefix": "<string>",
"storageAccountName": "my-storage-account"
}
'import requests
url = "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/{bucketId}"
payload = {
"accessKey": "<string>",
"secretKey": "<string>",
"endpoint": "<string>",
"bucket": "<string>",
"region": "<string>",
"checkConnectivityPrefix": "<string>",
"storageAccountName": "my-storage-account"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
accessKey: '<string>',
secretKey: '<string>',
endpoint: '<string>',
bucket: '<string>',
region: '<string>',
checkConnectivityPrefix: '<string>',
storageAccountName: 'my-storage-account'
})
};
fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/{bucketId}', 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}/buckets/{bucketId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'accessKey' => '<string>',
'secretKey' => '<string>',
'endpoint' => '<string>',
'bucket' => '<string>',
'region' => '<string>',
'checkConnectivityPrefix' => '<string>',
'storageAccountName' => 'my-storage-account'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/{bucketId}"
payload := strings.NewReader("{\n \"accessKey\": \"<string>\",\n \"secretKey\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"bucket\": \"<string>\",\n \"region\": \"<string>\",\n \"checkConnectivityPrefix\": \"<string>\",\n \"storageAccountName\": \"my-storage-account\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/{bucketId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"accessKey\": \"<string>\",\n \"secretKey\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"bucket\": \"<string>\",\n \"region\": \"<string>\",\n \"checkConnectivityPrefix\": \"<string>\",\n \"storageAccountName\": \"my-storage-account\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/{bucketId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"accessKey\": \"<string>\",\n \"secretKey\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"bucket\": \"<string>\",\n \"region\": \"<string>\",\n \"checkConnectivityPrefix\": \"<string>\",\n \"storageAccountName\": \"my-storage-account\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"error": "<string>"
}Update storage bucket
Updates storage bucket details. This only updates fields that were set in the request body. Before updating the bucket details, it is required to verify the connection using the POST /api/organizations//buckets/verify endpoint.
The verification process:
- Call the verify endpoint with the new bucket details.
- Poll the verify endpoint until it responds with
connectionStatus: connected. - If the endpoint responds with
connectionStatus: error, the verification has failed.
Only proceed with updating the bucket details after receiving a connected status.
The polling interval and timeout should be determined based on your application’s requirements.
POST
/
api
/
organizations
/
{organizationId}
/
buckets
/
{bucketId}
Update storage bucket
curl --request POST \
--url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/{bucketId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"accessKey": "<string>",
"secretKey": "<string>",
"endpoint": "<string>",
"bucket": "<string>",
"region": "<string>",
"checkConnectivityPrefix": "<string>",
"storageAccountName": "my-storage-account"
}
'import requests
url = "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/{bucketId}"
payload = {
"accessKey": "<string>",
"secretKey": "<string>",
"endpoint": "<string>",
"bucket": "<string>",
"region": "<string>",
"checkConnectivityPrefix": "<string>",
"storageAccountName": "my-storage-account"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
accessKey: '<string>',
secretKey: '<string>',
endpoint: '<string>',
bucket: '<string>',
region: '<string>',
checkConnectivityPrefix: '<string>',
storageAccountName: 'my-storage-account'
})
};
fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/{bucketId}', 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}/buckets/{bucketId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'accessKey' => '<string>',
'secretKey' => '<string>',
'endpoint' => '<string>',
'bucket' => '<string>',
'region' => '<string>',
'checkConnectivityPrefix' => '<string>',
'storageAccountName' => 'my-storage-account'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/{bucketId}"
payload := strings.NewReader("{\n \"accessKey\": \"<string>\",\n \"secretKey\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"bucket\": \"<string>\",\n \"region\": \"<string>\",\n \"checkConnectivityPrefix\": \"<string>\",\n \"storageAccountName\": \"my-storage-account\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/{bucketId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"accessKey\": \"<string>\",\n \"secretKey\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"bucket\": \"<string>\",\n \"region\": \"<string>\",\n \"checkConnectivityPrefix\": \"<string>\",\n \"storageAccountName\": \"my-storage-account\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/buckets/{bucketId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"accessKey\": \"<string>\",\n \"secretKey\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"bucket\": \"<string>\",\n \"region\": \"<string>\",\n \"checkConnectivityPrefix\": \"<string>\",\n \"storageAccountName\": \"my-storage-account\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"error": "<string>"
}Authorizations
ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2
Body
application/json
Was this page helpful?