Update S3 Storage
API server
https://app.coolify.io/api/v1Update S3 storage by UUID. The type cannot change, and only the fields of the storage type are accepted.
Authorization
bearerAuth Go to Keys & Tokens / API tokens and create a new token. Use the token as the bearer token.
In: header
Path Parameters
S3 Storage UUID
Request Body
application/json
S3 storage fields to update.
TypeScript Definitions
Use the request body type in TypeScript.
A friendly name for the storage.
Optional description.
The endpoint URL, in the format of the storage type (see Create S3 Storage).
S3 bucket name. Only for S3 storages.
S3 region. Only for S3 storages.
Use path-style URLs (endpoint/bucket). Set to false for providers that only accept virtual-hosted-style URLs (bucket.endpoint), such as Alibaba Cloud OSS.
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: sending a password switches the login to the password.
SFTP only: the UUID of a private key of your team to log in with. Null switches the login to the saved password.
Whether the storage is marked usable.
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "https://app.coolify.io/api/v1/s3-storages/string" \ -H "Content-Type: application/json" \ -d '{}'{ "uuid": "string"}{ "message": "Unauthenticated."}{ "message": "Resource not found."}{ "message": "Validation error.", "errors": { "name": [ "The name field is required." ], "api_url": [ "The api url field is required.", "The api url format is invalid." ] }}List S3 Storages GET
List all backup storages (S3, SFTP, FTPS, and WebDAV) for the authenticated team.
Validate S3 Storage POST
Validate a storage connection. S3: lists the bucket (ListObjectsV2). SFTP, FTPS, and WebDAV: lists the backup directory; for SFTP, the first successful validation pins the host key of the server.
