Skip to content
post

Create bucket

Endpoint

posthttps://<REGION>.cloud.appwrite.io/v1/storage/buckets

Description

Create a new storage bucket.

Required scopes

buckets.write

Authentication

Initialize the Appwrite client with setProject() and a server API key (setKey()). For direct REST calls, send X-Appwrite-Project and X-Appwrite-Key.

Parameters

string
Required

Unique Id. Choose your own unique ID or pass the string unique() to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.

string
Required

Bucket name

string
Required

Permissions type model to use for reading files in this bucket. You can use bucket-level permission set once on the bucket using the read and write params, or you can set file-level permission where each file read and write params will decide who has access to read and write to each file individually. learn more about permissions and get a full list of available permissions.

array

An array of strings with read permissions. By default no user is granted with any read permissions. learn more about permissions and get a full list of available permissions.

array

An array of strings with write permissions. By default no user is granted with any write permissions. learn more about permissions and get a full list of available permissions.

boolean

Is bucket enabled?

integer

Maximum file size allowed in bytes. Maximum allowed value is 30MB. For self-hosted setups you can change the max limit by changing the _APP_STORAGE_LIMIT environment variable. Learn more about storage environment variables

array

Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.

boolean

Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled

boolean

Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled

Status
Content type
201
application/json

Bucket

Name
Type
Description
string

Bucket ID.

integer

Bucket creation date in Unix timestamp.

integer

Bucket update date in Unix timestamp.

arrayof string

File read permissions.

arrayof string

File write permissions.

string

Bucket permission model. Possible values: bucket or file

string

Bucket name.

boolean

Bucket enabled.

integer

Maximum file size supported.

arrayof string

Allowed file extensions.

boolean

Bucket is encrypted.

boolean

Virus scanning is enabled.

Ruby
require 'appwrite'


client = Appwrite::Client.new


client
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key


storage = Appwrite::Storage.new(client)


response = storage.create_bucket(bucket_id: '[BUCKET_ID]', name: '[NAME]', permission: 'file')


puts response.inspect