Skip to navigation
Buckets

update

Rename a bucket or change its file-access settings. Send fileAccess to replace the settings, null to remove them, or omit it to keep them.

Authentication

X-API-Keystring
API Key authentication via header

Path parameters

bucketIdintegerRequired
The bucketId of the bucket being updated.

Request

This endpoint expects an object.
newNamestringOptional
The new name of the bucket being renamed.
fileAccessobject or nullOptional

Controls access to normal file URLs and the maximum lifetime of temporary links. For each setting, use the document value first, then bucket, then account. If none is set, defaults are public access and a 300-second link lifetime. Normal file URLs do not expire.

fileAccessRevisionintegerOptional>=0Deprecated

Deprecated. Not needed and ignored when updating file-access settings.

Response

Bucket successfully updated
bucketobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
503
Service Unavailable Error