Buckets
Buckets (cbk_): creating, settings, size and deleting them.
- Creating a bucket failed with 503 storage_unavailable. What now?Storage for the new bucket couldn't be set up at that moment. Wait a little and try again.Troubleshooting
- How do I create a bucket with the API?Create a bucket inside a project in the Console, or with POST /v1/projects/{project_id}/buckets. You get a bucket id (cbk_) back.How-to
- How do I delete a bucket with the API?Delete a bucket from the Console or with DELETE /v1/buckets/{bucket_id}. It disappears and stops counting toward your usage.How-to
- How do I list the buckets in a project?GET /v1/projects/{project_id}/buckets returns the project's buckets, newest first, with their storage use.How-to
- How do I make a bucket read-only for an app or person?There's no read-only switch. Give that app a key with only buckets:read, so it can read and download but not change anything.How-to
- How do I rename a bucket or change its settings?PATCH /v1/buckets/{bucket_id} changes name, description, preview or visibility. Only the fields you send change.How-to
- How do I see how much space a bucket is using?GET /v1/buckets/{bucket_id} returns storage.used_bytes, pending_bytes and limit_bytes. The Console shows usage too.How-to
- How do I set up a bucket for website images?Make a public bucket for images, upload them with the right content type, and use the img.cdn.clatterlabs.xyz links in your site.How-to
- How do I turn off preview for a bucket with the API?Send PATCH /v1/buckets/{bucket_id} with "preview": false, or change it in the bucket's settings in the Console.How-to
- How many buckets can I have?Up to 100 buckets per project and 100 projects per account. Total storage is set by your plan.FAQ
- How many files can a bucket hold?The docs limit storage (10 GB per bucket), not object count. Preview has its own limits: about 20,000 files per zip.FAQ
- How much can one bucket hold?Up to 10 GB (10,737,418,240 bytes) per bucket, counting stored zips and assets plus unfinished uploads, on every plan.FAQ
- I deleted a bucket by mistake. Can I get it back?There's no published undelete for buckets. Contact support straight away with your Account ID and the bucket id.FAQ
- I get 413 bucket_full. What can I do?The upload would take the bucket past 10 GB, counting unfinished uploads. Abort stale uploads, delete objects or use another bucket.Troubleshooting
- Should my bucket be public or private?Keep code buckets private. Use a separate public bucket for files meant for anyone, like website images and downloads.FAQ
- What are the rules for bucket names?Bucket names are up to 80 characters and descriptions up to 500. The bucket id (cbk_) identifies the bucket.Reference
- What do the fields on a bucket mean?A bucket returns its id, project, name, preview, visibility, code (ref, files, bytes), storage (used, pending, limit) and encryption.Reference
- What does the encryption field on a bucket tell me?It describes how the bucket's stored files are encrypted: AES-256-GCM with the bucket's own key, wrapped by a Clatter Labs master key.FAQ
- What is a bucket?A bucket lives in one project and holds up to 10 GB of code and assets, with its own encryption key, code tree, events and backups.Explainer
- What's the difference between the 10 GB bucket limit and my plan's storage?Each bucket holds up to 10 GB. Your plan sets the total across all buckets, from 1 GB on Free to 1 TB on Ultra.FAQ
- Why is code.ref null on my bucket?ref stays null until the first zip is unpacked. Buckets with only assets, or with preview off, have no code tree.FAQ
- Why is my bucket's used space bigger than my zip?used_bytes counts every stored zip and asset in the bucket, not just the latest, plus pending_bytes for unfinished uploads.FAQ
Still need help?
Tried the steps above and still stuck? Email us. We usually reply within the first hour, and always within 24 hours. A full support team is with you.
Infrastructure questions, or permanent deletion of your data
infrastructure@clatterlabs.xyzFor deleting your whole account or the data of one service.