Skip to content

Create Connection

POST
/v1/settings/connections
curl --request POST \
--url https://example.com/v1/settings/connections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "endpoint": "", "region": "us-east-1", "access_key_id": "example", "secret_access_key": "example" }'
Media typeapplication/json
ConnectionInput
object
name
required
Name
string
endpoint
Endpoint

Empty for AWS S3. Otherwise the storage’s address, e.g. https://<account>.r2.cloudflarestorage.com or http://localhost:9000 for MinIO.

string
""
region
Region

auto for Cloudflare R2.

string
default: us-east-1
access_key_id
required
Access Key Id
string
secret_access_key
Any of:
string

Successful Response

Media typeapplication/json
Connection

A connection as the API shows it: without its secret key.

object
id
required
Id
string
name
required
Name
string
endpoint
required
Endpoint
string
region
required
Region
string
access_key_id
required
Access Key Id
string
created_at
required
Created At
string format: date-time

Example generated

{
"id": "example",
"name": "example",
"endpoint": "example",
"region": "example",
"access_key_id": "example",
"created_at": "2026-04-15T12:00:00Z"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object

Example generated

{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}