Create S3 storage connection

post

https://{hostname}/api/v1/s3_storage_connections

Creates a new S3-compatible storage connection with inline connectivity validation.

Body Params

access_key_id

string

required

S3 access key ID.

bucket

string | null

Bucket name. For Linode virtual-hosted endpoints this is derived from
the host; if supplied it must match. For Linode bare-regional endpoints
this is required (use this shape for dotted bucket names). For MinIO
this is always required.

config

object

required

Provider-specific configuration (e.g., {"force_path_style": true} for MinIO).

contract_id

string

required

Contract ID.

display_name

string

required

Human-readable name for the connection.

endpoint

string

required

S3-compatible endpoint URL. For Linode: virtual-hosted
https://<bucket>.<region>.linodeobjects.com or bare regional
https://<region>.linodeobjects.com (with body bucket). For MinIO:
http://<host>[:<port>] or https://<host>[:<port>]. Surrounding
whitespace and any trailing / are stripped before normalization.
Detailed validation lives in the service layer so error responses use
invalid_endpoint with provider-specific detail.

folder

string | null

Optional folder (prefix) within the bucket. Leading/trailing ASCII
spaces are trimmed; leading/trailing / are stripped; consecutive /
are rejected. Maximum normalized length is 944 characters (leaves
room for the validation sub-key within S3's 1024-byte object-key
limit). Missing, JSON null, and empty string all create the empty
prefix.

group_id

string

required

Group ID.

provider

region

string | null

Region. Ignored for Linode (always derived from the endpoint host).
For MinIO, optional; defaults to us-east-1 when omitted or empty.

secret_access_key

string

required

S3 secret access key.

Responses

201S3 storage connection created.

400Bad request.

401Unauthorized.

403Forbidden.

422Connectivity validation failed.

500Internal server error.

502Storage endpoint unreachable.