Docs

Bucket Object

Properties

Name Type Description
$id string

Bucket ID.

$createdAt string

Bucket creation time in ISO 8601 format.

$updatedAt string

Bucket update date in ISO 8601 format.

$permissions string[]

Bucket permissions. Learn more about permissions.

fileSecurity boolean

Whether file-level security is enabled. Learn more about permissions.

name string

Bucket name.

enabled boolean

Bucket enabled.

maximumFileSize integer

Maximum file size supported.

allowedFileExtensions string[]

Allowed file extensions.

compression string

Compression algorithm choosen for compression. Will be one of none, gzip, or zstd.

encryption boolean

Bucket is encrypted.

antivirus boolean

Virus scanning is enabled.

Examples

JSON

{
    "$id": "5e5ea5c16897e",
    "$createdAt": "2020-10-15T06:38:00.000+00:00",
    "$updatedAt": "2020-10-15T06:38:00.000+00:00",
    "$permissions": [
        "read(\"any\")"
    ],
    "fileSecurity": true,
    "name": "Documents",
    "enabled": false,
    "maximumFileSize": 100,
    "allowedFileExtensions": [
        "jpg",
        "png"
    ],
    "compression": "gzip",
    "encryption": false,
    "antivirus": false
}