Skip to main content
POST
Create Storage Connection

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

Handle a Volume references it by; immutable once created

Minimum string length: 1
kind
enum<string>
required
Available options:
s3,
posix
description
string
default:""
endpoint
string
default:""

S3 endpoint, e.g. https://minio.internal:9000

region
string
default:""
bucket
string
default:""
access_key
string
default:""
secret_key
string
default:""

Stored encrypted; never returned

base_path
string
default:""

Absolute path a posix connection is rooted at

fs_view
enum<string>
default:none

Whether this content is reachable as files. none is the honest default: reading a bucket over the S3 API and mounting it are different capabilities. gateway asserts fs_path is the same content (s3fs, a CSI driver); the platform cannot verify that. pull fetches per node on demand.

Available options:
none,
gateway,
pull
fs_path
string
default:""
allowed_prefixes
string[]

Paths under this connection that may be referenced. Empty means all of it.

usable_by
string[]

Projects that may reference it. Empty means every project.

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:""