Create S3 Storage
API server
https://app.coolify.io/api/v1Create a new S3 storage configuration for the authenticated team.
Authorization
bearerAuth Go to Keys & Tokens / API tokens and create a new token. Use the token as the bearer token.
In: header
Request Body
application/json
S3 storage details
TypeScript Definitions
Use the request body type in TypeScript.
The storage protocol. It cannot change later.
"s3""s3" | "sftp" | "ftps" | "webdav"A friendly name for the storage.
Optional description.
S3: the S3-compatible endpoint URL. SFTP and FTPS: sftp://host:port/directory or ftps://host:port/directory (explicit TLS); the directory is an absolute path, and without one the login directory is used. WebDAV: the https URL of the backup directory.
S3 bucket name. Required for S3, not allowed for the other types.
S3 region. Required for S3, not allowed for the other types.
Use path-style URLs (endpoint/bucket). Set to false for providers that only accept virtual-hosted-style URLs (bucket.endpoint). Default: false for Alibaba Cloud OSS, Tencent Cloud COS, and Volcengine TOS endpoints, true for all other endpoints.
S3 only. Do not check the TLS certificate of the endpoint. Use only for endpoints with a self-signed or private CA certificate. Default: false.
S3: the access key. Other types: the username.
S3: the secret key. Other types: the password. SFTP: not needed with private_key_uuid.
SFTP only: the UUID of a private key of your team to log in with instead of a password.
Whether the storage is marked usable.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://app.coolify.io/api/v1/s3-storages" \ -H "Content-Type: application/json" \ -d '{ "name": "My S3 Storage", "endpoint": "https://s3.us-east-1.amazonaws.com", "key": "string" }'{ "uuid": "og888os"}{ "message": "Invalid token."}{ "message": "Unauthenticated."}{ "message": "Validation error.", "errors": { "name": [ "The name field is required." ], "api_url": [ "The api url field is required.", "The api url format is invalid." ] }}