/storage/buckets/{bucketName}Update Bucket
Updates a bucket's settings; only the fields sent change.
A system bucket's settings, its mode included, cannot change (409).
mode is the bucket's access preset:
private(default): authenticated access by role tier and the IAMbuckets:<verb>ceiling.public: private's rules, plus anonymous read of objects atGET /@{projectSlug}/storage/public/{bucketName}/{path}, which answers 302 to a short-lived presigned URL and is rate limited per client IP (429 K9O_RATE_LIMITED). Never anonymous list, upload or delete.custom: the bucket's storage policy,policy.buckets.<bucket>declared in a migration, decides each object action for every caller, PROJECT_ADMIN included; an action the policy does not grant is denied. Managing the bucket and authoring its policy never go through it, so an admin can always change the policy or switch the mode back.
Setting or changing the mode is its own IAM action, buckets:set_mode (PROJECT_ADMIN by default; a buckets:update widening does not include it), and is audited (data.write.storage.bucket.mode_changed). public needs confirmPublic: true; custom needs the bucket to have a storage policy already.
The legacy public boolean is an alias of mode (true = public, false = private) under the same rules; responses carry both, with public derived from mode.
| bucketName * | path | The bucket's name. It is unique within the project. |
| projectSlug * | path | The project's slug: the path segment after It is unique within the org. |
| mode | "private" | "public" | "custom" | A new mode. Moving to |
| confirmPublic | boolean | Must be true to move the bucket to |
| public | boolean | Older form of It must agree with |
| fileSizeLimit | any | The largest object an upload may write, in bytes, or null for no bucket limit. |
| One of: integer | ||
| or: null | ||
| allowedMimeTypes | any | MIME types an upload may have, at most 64. An empty array or null allows any type. |
| One of: string[] | ||
| or: null | ||
| versioning | boolean | Keep earlier versions of an object when it is overwritten. |
| deleteAfterDays | any | Delete objects this many days after they were last uploaded (an overwrite starts the count again). From that point the object reads as not found, and it is removed from the bucket within a few hours. Only objects uploaded through the platform are deleted: an object written straight into a customer storage location, or uploaded before per-object records began, is kept. Nothing is deleted while the project is under a legal hold. On a customer storage location, setting it first tests that the platform can write and delete there. Send null to keep objects until deleted. |
| One of: integer | ||
| or: null | ||
| byosBindingId | any | Link the bucket to a storage location ( This is the only setting a system bucket accepts. |
| One of: string | ||
| or: null | ||
| HTTP | K9O Code | Description |
|---|---|---|
| 200 | Success | |
| 400 | K9O_INVALID_FIELD_VALUE | An invalid field: for mode, confirmPublic is missing for public (reason confirm_public_required), the bucket has no storage policy for custom (custom_mode_requires_policy), or mode and the legacy public flag disagree (mode_public_conflict). |
| 403 | K9O_ACCESS_DENIED | The caller does not have permission to update this storage bucket. |
| 403 | K9O_IAM_POLICY_DENIED | The bound IAM policy ceiling denies buckets:set_mode: setting or changing a bucket's mode is its own action, PROJECT_ADMIN-only by default; a policy that widens buckets:update does not widen it. |
| 404 | K9O_BUCKET_NOT_FOUND | No bucket with the specified name exists in this project. |
| 409 | K9O_STATE_CONFLICT | Only a system bucket's storage location can change; its mode and other settings are the platform's. Also answered when turning on deleteAfterDays for a bucket on a customer storage location fails the write or delete test there (reason location_write_check_failed or location_delete_check_failed); nothing is changed. |
| data * | object | A storage bucket and its settings. |
| name * | string | The bucket name, unique in the project. |
| mode * | "private" | "public" | "custom" | Who can reach the bucket's objects. |
| public * | boolean | True when Derived from |
| fileSizeLimit * | any | The largest object an upload may write, in bytes; null when the bucket sets no limit. |
| One of: integer | ||
| or: null | ||
| allowedMimeTypes * | string[] | MIME types an upload may have. Empty means any type. |
| versioning * | boolean | Whether earlier versions of an overwritten object are kept. |
| deleteAfterDays * | any | Objects are deleted this many days after they were last uploaded: from that point they read as not found, and they are removed from the bucket within a few hours. Null keeps them until deleted. Only objects uploaded through the platform are deleted: one written straight into a customer storage location, or uploaded before per-object records began, is kept. |
| One of: integer | ||
| or: null | ||
| createdAt * | string <date-time> | When the bucket was created. |
| updatedAt * | string <date-time> | When the bucket's settings last changed. |
| system * | boolean | True for a bucket the platform creates and writes ( A system bucket can't be deleted, its objects can't be written or deleted through the API, and only its storage location can change. |
| byosBindingId * | any | The storage location ( |
| One of: string | ||
| or: null | ||
| meta * | any | Request metadata: cost, timing and correlation ids. |
// const k9o = new K9o({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })
const { data } = await k9o.storage.updateBucket('product-images', {
public: true,
fileSizeLimit: null,
allowedMimeTypes: null,
versioning: true,
deleteAfterDays: null
})Showing example in TypeScript
{
"public": true,
"fileSizeLimit": null,
"allowedMimeTypes": null,
"versioning": true,
"deleteAfterDays": null
}{
"data": {
"name": "string",
"mode": "private",
"public": false,
"fileSizeLimit": 0,
"allowedMimeTypes": [
"string"
],
"versioning": false,
"deleteAfterDays": 0,
"createdAt": "string",
"updatedAt": "string",
"system": false,
"byosBindingId": "string"
}
}