Skip to content

js-bao-wss-client


js-bao-wss-client / CreateBlobBucketParams

Interface: CreateBlobBucketParams ​

Parameters for blobBuckets.createBucket() (admin/owner only). Names the bucket, picks its retention tier, and sets its access preset or custom rule set.

Properties ​

accessPolicy? ​

optional accessPolicy?: BlobBucketAccessPolicy

Deprecated ​

Legacy access enum; accepted as an input alias for preset.


bucketKey ​

bucketKey: string

Human-friendly identifier for the bucket (max 64 chars, alnum + dash/underscore)


description? ​

optional description?: string

Optional description


name ​

name: string

Display name for the bucket


preset? ​

optional preset?: "public" | "authenticated" | "admin-only" | "personal-uploads"

Access preset. One of public | authenticated | admin-only | personal-uploads. Provide this OR a ruleSetId (custom). The legacy accessPolicy enum is still accepted as an input alias.


ruleSetId? ​

optional ruleSetId?: string

Rule set ID for CEL-based access control (makes the bucket custom).


ttlTier ​

ttlTier: BlobBucketTtlTier

Retention tier - controls automatic expiration

Documentation validated against js-bao-wss-client 3.4.0 · js-bao 0.11.0 · primitive-admin 1.0.62 · primitive-app 3.1.0 — 2026-09-30