Update Storage Connection
curl --request PATCH \
--url https://{host}/api/admin/storage-connections/{name} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "<string>",
"endpoint": "<string>",
"region": "<string>",
"bucket": "<string>",
"access_key": "<string>",
"secret_key": "<string>",
"base_path": "<string>",
"fs_path": "<string>",
"allowed_prefixes": [
"<string>"
],
"usable_by": [
"<string>"
]
}
'import requests
url = "https://{host}/api/admin/storage-connections/{name}"
payload = {
"description": "<string>",
"endpoint": "<string>",
"region": "<string>",
"bucket": "<string>",
"access_key": "<string>",
"secret_key": "<string>",
"base_path": "<string>",
"fs_path": "<string>",
"allowed_prefixes": ["<string>"],
"usable_by": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
endpoint: '<string>',
region: '<string>',
bucket: '<string>',
access_key: '<string>',
secret_key: '<string>',
base_path: '<string>',
fs_path: '<string>',
allowed_prefixes: ['<string>'],
usable_by: ['<string>']
})
};
fetch('https://{host}/api/admin/storage-connections/{name}', 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://{host}/api/admin/storage-connections/{name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'endpoint' => '<string>',
'region' => '<string>',
'bucket' => '<string>',
'access_key' => '<string>',
'secret_key' => '<string>',
'base_path' => '<string>',
'fs_path' => '<string>',
'allowed_prefixes' => [
'<string>'
],
'usable_by' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://{host}/api/admin/storage-connections/{name}"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"region\": \"<string>\",\n \"bucket\": \"<string>\",\n \"access_key\": \"<string>\",\n \"secret_key\": \"<string>\",\n \"base_path\": \"<string>\",\n \"fs_path\": \"<string>\",\n \"allowed_prefixes\": [\n \"<string>\"\n ],\n \"usable_by\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://{host}/api/admin/storage-connections/{name}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"region\": \"<string>\",\n \"bucket\": \"<string>\",\n \"access_key\": \"<string>\",\n \"secret_key\": \"<string>\",\n \"base_path\": \"<string>\",\n \"fs_path\": \"<string>\",\n \"allowed_prefixes\": [\n \"<string>\"\n ],\n \"usable_by\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/admin/storage-connections/{name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"region\": \"<string>\",\n \"bucket\": \"<string>\",\n \"access_key\": \"<string>\",\n \"secret_key\": \"<string>\",\n \"base_path\": \"<string>\",\n \"fs_path\": \"<string>\",\n \"allowed_prefixes\": [\n \"<string>\"\n ],\n \"usable_by\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"kind": "<string>",
"description": "",
"endpoint": "",
"region": "",
"bucket": "",
"access_key": "",
"base_path": "",
"fs_view": "none",
"fs_path": "",
"allowed_prefixes": [
"<string>"
],
"usable_by": [
"<string>"
],
"has_secret": false,
"probes": {},
"created_by": ""
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}PATCH
/
api
/
admin
/
storage-connections
/
{name}
Update Storage Connection
curl --request PATCH \
--url https://{host}/api/admin/storage-connections/{name} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "<string>",
"endpoint": "<string>",
"region": "<string>",
"bucket": "<string>",
"access_key": "<string>",
"secret_key": "<string>",
"base_path": "<string>",
"fs_path": "<string>",
"allowed_prefixes": [
"<string>"
],
"usable_by": [
"<string>"
]
}
'import requests
url = "https://{host}/api/admin/storage-connections/{name}"
payload = {
"description": "<string>",
"endpoint": "<string>",
"region": "<string>",
"bucket": "<string>",
"access_key": "<string>",
"secret_key": "<string>",
"base_path": "<string>",
"fs_path": "<string>",
"allowed_prefixes": ["<string>"],
"usable_by": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
endpoint: '<string>',
region: '<string>',
bucket: '<string>',
access_key: '<string>',
secret_key: '<string>',
base_path: '<string>',
fs_path: '<string>',
allowed_prefixes: ['<string>'],
usable_by: ['<string>']
})
};
fetch('https://{host}/api/admin/storage-connections/{name}', 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://{host}/api/admin/storage-connections/{name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'endpoint' => '<string>',
'region' => '<string>',
'bucket' => '<string>',
'access_key' => '<string>',
'secret_key' => '<string>',
'base_path' => '<string>',
'fs_path' => '<string>',
'allowed_prefixes' => [
'<string>'
],
'usable_by' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://{host}/api/admin/storage-connections/{name}"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"region\": \"<string>\",\n \"bucket\": \"<string>\",\n \"access_key\": \"<string>\",\n \"secret_key\": \"<string>\",\n \"base_path\": \"<string>\",\n \"fs_path\": \"<string>\",\n \"allowed_prefixes\": [\n \"<string>\"\n ],\n \"usable_by\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://{host}/api/admin/storage-connections/{name}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"region\": \"<string>\",\n \"bucket\": \"<string>\",\n \"access_key\": \"<string>\",\n \"secret_key\": \"<string>\",\n \"base_path\": \"<string>\",\n \"fs_path\": \"<string>\",\n \"allowed_prefixes\": [\n \"<string>\"\n ],\n \"usable_by\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/admin/storage-connections/{name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"region\": \"<string>\",\n \"bucket\": \"<string>\",\n \"access_key\": \"<string>\",\n \"secret_key\": \"<string>\",\n \"base_path\": \"<string>\",\n \"fs_path\": \"<string>\",\n \"allowed_prefixes\": [\n \"<string>\"\n ],\n \"usable_by\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"kind": "<string>",
"description": "",
"endpoint": "",
"region": "",
"bucket": "",
"access_key": "",
"base_path": "",
"fs_view": "none",
"fs_path": "",
"allowed_prefixes": [
"<string>"
],
"usable_by": [
"<string>"
],
"has_secret": false,
"probes": {},
"created_by": ""
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Every field optional, and name absent on purpose.
A Volume references a connection by name, so a rename would leave every reference pointing at nothing. Deleting and recreating says that loudly.
Available options:
none, gateway, pull Response
Successful Response
Show child attributes
Show child attributes