Coolify Octri Demo
PATCH/s3-storages/{uuid}

Update an S3 storage

Updates the configuration of an S3 storage. Supply the fields you want to change, such as its bucket, endpoint, access key, or usability status. The response includes the storage UUID.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 8 body fields
uuidstringrequired
The UUID of the S3 storage to update.

The S3 storage fields to update; include the fields whose values you want to change.

bucketstringoptional
S3 bucket name.
descriptionstringoptional
Optional description.
endpointstringoptional
S3-compatible endpoint URL.
is_usablebooleanoptional
Whether the storage is marked usable.
keystringoptional
Access key.
namestringoptional
A friendly name for the storage.
regionstringoptional
S3 region.
secretstringoptional
Secret key.

4 status codes
200Returns an object containing the UUID of the updated S3 storage.
uuidstringoptional
401Returned when the request is unauthenticated.
messagestringoptional
404Returned when the S3 storage does not exist.
messagestringoptional
422Returned when one or more submitted S3 storage fields fail validation.
errorsobjectoptional
messagestringoptional

Error handling

A 401 is returned when the request is unauthenticated. A 404 is returned when the S3 storage identified by the uuid path parameter does not exist. A 422 is returned when a submitted field fails validation.