Skip to main content
PATCH
Update Storage Connection

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

name
string
required

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.

description
string | null
endpoint
string | null
region
string | null
bucket
string | null
access_key
string | null
secret_key
string | null
base_path
string | null
fs_view
enum<string> | null
Available options:
none,
gateway,
pull
fs_path
string | null
allowed_prefixes
string[] | null
usable_by
string[] | null

Response

Successful Response

name
string
required
kind
string
required
description
string
default:""
endpoint
string
default:""
region
string
default:""
bucket
string
default:""
access_key
string
default:""
base_path
string
default:""
fs_view
string
default:none
fs_path
string
default:""
allowed_prefixes
string[]
usable_by
string[]
has_secret
boolean
default:false
probes
Probes · object
created_by
string
default:""