Update S3 Storage

API server

https://app.coolify.io/api/v1

Choose where to send API requests

This changes the request URL and code examples on every endpoint page.

API server type

Requests will use

https://app.coolify.io/api/v1

Use only a Coolify URL you trust. Sending a test request also sends the API token you enter.

PATCH
/s3-storages/{uuid}

Update S3 storage by UUID. The type cannot change, and only the fields of the storage type are accepted.

Authorization

bearerAuth
AuthorizationBearer <token>

Go to Keys & Tokens / API tokens and create a new token. Use the token as the bearer token.

In: header

Path Parameters

uuid*string

S3 Storage UUID

Request Body

application/json

S3 storage fields to update.

TypeScript Definitions

Use the request body type in TypeScript.

name?string

A friendly name for the storage.

description?string

Optional description.

endpoint?string

The endpoint URL, in the format of the storage type (see Create S3 Storage).

bucket?string

S3 bucket name. Only for S3 storages.

region?string

S3 region. Only for S3 storages.

use_path_style_endpoint?boolean

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.

skip_tls_verification?boolean

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.

key?string

S3: the access key. Other types: the username.

secret?string

S3: the secret key. Other types: the password. SFTP: sending a password switches the login to the password.

private_key_uuid?string

SFTP only: the UUID of a private key of your team to log in with. Null switches the login to the saved password.

is_usable?boolean

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."    ]  }}