Buckets
Create, update, delete buckets and manage bucket-level permissions and sharing
postBulk copy content
Copies multiple uploads to a new folder, preserving metadata and thumbnails without re-processing.
postBulk delete content
Permanently deletes multiple uploads or folders in a single operation.
postBulk move content
Moves multiple uploads or folders to a new parent folder and/or updates their tags.
postCreate bucket
Creates a new storage bucket with the specified configuration and destination settings.
postDelete bucket
Permanently removes a bucket and optionally all its contents. Use force=true to delete non-empty buckets.
postDelete bucket lifecycle
Removes every lifecycle rule from the bucket.
postGet bucket
Retrieves details for a specific bucket including configuration, aliases, and portal settings.
postGet bucket lifecycle
Returns the lifecycle rules that automatically delete uploads in a bucket.
postGet bucket statistics
A time series over the bucket, one row per hour, day or month (UTC) between `start_time` and `end_time`, every period present: `size_bytes` is the bytes stored at the end of each period (a level), `uploaded_bytes` and `upload_count` are what that period's uploads brought (a flow). Downloads and bandwidth are not recorded yet and read 0. Needs the bucket admin role.
postGet owner usage
Storage totals for everything one owner owns: bytes and live uploads summed over the owner's buckets, with the per-bucket breakdown (largest first) and the per-bucket storage cap. `owner_scope.personal` covers the caller's own buckets; buckets shared with the caller are not theirs and are not counted. `owner_scope.team` covers a team's buckets and needs a upl role of reader or above in that team, else PermissionDenied. Totals count the same rows GetBucketStatistics does (every upload not deleted), read from a per-bucket rollup refreshed every few minutes rather than counted per request: `computed_at` says how fresh they are, and a bucket created since the last refresh is counted live. **Access:** a token that reaches the whole owner: a user token, an unrestricted personal access key for personal scope, or a team-wide access key for its own team. Folder- and bucket-scoped integration tokens, client_credentials tokens, and any token carrying RAR authorization details (which includes every access key restricted to particular buckets) are refused with PermissionDenied.
postGet search token
Generates a scoped search token for querying uploads within a bucket using Typesense.
postGrant bucket permission
Grants a user access to a bucket with the specified permission level (read, read-write, or admin).
postGrant resource permission
Grants a user access to a specific folder or upload within a bucket.
postList bucket permissions
Lists all users who have been granted access to a bucket and their permission levels.
postList bucket types
Lists all available bucket types including built-in types and integration-defined types.
postList buckets
Retrieves all buckets owned by or shared with the authenticated user, including shared resource access.
postList resource permissions
Lists all folder and upload level permissions granted within a bucket.
postMove a bucket to a different owner
Transfers ownership of a bucket to a team or back to the caller. Requires admin on the bucket and the upl admin team role in each team involved. The bucket's slug, aliases and URLs are unchanged; individual permission grants are preserved, while access-key grants that would cross the new ownership boundary are revoked.
postPreview bucket lifecycle
Counts the uploads and previous versions that the given (or stored) lifecycle rules would delete if they ran now.
postPut bucket lifecycle
Replaces the bucket's lifecycle rules. Matching uploads are deleted automatically.
postReprocess bucket
Reprocesses uploads in a bucket to regenerate thumbnails, AI metadata, or other derived data. Admin only.
postRestore subfolder access
Restores access to a previously revoked subfolder, removing the exception.
postRevoke bucket permission
Removes a user's access to a bucket.
postRevoke resource permission
Removes a user's access to a specific folder or upload.
postRevoke subfolder access
Revokes access to a subfolder within a shared parent folder, creating an exception to inherited permissions.
postUpdate bucket
Updates bucket settings including name, aliases, type, and portal configuration.