The Storage service allows you to manage your project files. Using the Storage service, you can upload, view, download, and query all your project files.
Files are managed using buckets. Storage buckets are similar to Collections we have in our Databases service. The difference is, buckets also provide more power to decide what kinds of files, what sizes you want to allow in that bucket, whether or not to encrypt the files, scan with antivirus and more.
Using Appwrite permissions architecture, you can assign read or write access to each bucket or file in your project for either a specific user, team, user role, or even grant it with public access (any
). You can learn more about how Appwrite handles permissions and access control.
The preview endpoint allows you to generate preview images for your files. Using the preview endpoint, you can also manipulate the resulting image so that it will fit perfectly inside your app in terms of dimensions, file size, and style. The preview endpoint also allows you to change the resulting image file format for better compression or image quality for better delivery over the network.
https://cloud.appwrite.io/v1
List buckets
Get a list of all the storage buckets. You can use the query params to filter your results.
Request
search Search term to filter your list results. Max length: 256 chars.
limit Results limit value. By default will return maximum 25 results. Maximum of 100 results allowed per request.
offset Results offset. The default value is 0. Use this param to manage pagination.
cursor ID of the bucket used as the starting point for the query, excluding the bucket itself. Should be used for efficient pagination when working with large sets of data.
cursorDirection Direction of the cursor, can be either 'before' or 'after'.
orderType Order result by ASC or DESC order.
Response
200
GET /storage/buckets
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.list_buckets()
puts response.inspect
Create bucket
Create a new storage bucket.
Request
bucketId requiredUnique 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.name requiredBucket name
permission requiredPermissions type model to use for reading files in this bucket. You can use bucket-level permission set once on the bucket using the
read
andwrite
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.read 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.
write 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.
enabled Is bucket enabled?
maximumFileSize 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 variablesallowedFileExtensions Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
Response
201
POST /storage/buckets
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
Get Bucket
Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.
Request
bucketId requiredBucket unique ID.
Response
200
GET /storage/buckets/{bucketId}
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.get_bucket(bucket_id: '[BUCKET_ID]')
puts response.inspect
Update Bucket
Update a storage bucket by its unique ID.
Request
bucketId requiredBucket unique ID.
name requiredBucket name
permission requiredPermissions type model to use for reading files in this bucket. You can use bucket-level permission set once on the bucket using the
read
andwrite
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.read An array of strings with read permissions. By default inherits the existing read permissions. learn more about permissions and get a full list of available permissions.
write An array of strings with write permissions. By default inherits the existing write permissions. learn more about permissions and get a full list of available permissions.
enabled Is bucket enabled?
maximumFileSize Maximum file size allowed in bytes. Maximum allowed value is 30MB. For self hosted version you can change the limit by changing _APP_STORAGE_LIMIT environment variable. Learn more about storage environment variables
allowedFileExtensions Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
Response
200
PUT /storage/buckets/{bucketId}
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.update_bucket(bucket_id: '[BUCKET_ID]', name: '[NAME]', permission: 'file')
puts response.inspect
Delete Bucket
Delete a storage bucket by its unique ID.
Request
bucketId requiredBucket unique ID.
Response
204
DELETE /storage/buckets/{bucketId}
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.delete_bucket(bucket_id: '[BUCKET_ID]')
puts response.inspect
List Files
Get a list of all the user files. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of the project's files. Learn more about different API modes.
Request
bucketId requiredStorage bucket unique ID. You can create a new storage bucket using the Storage service server integration.
search Search term to filter your list results. Max length: 256 chars.
limit Maximum number of files to return in response. By default will return maximum 25 results. Maximum of 100 results allowed per request.
offset Offset value. The default value is 0. Use this param to manage pagination. learn more about pagination
cursor ID of the file used as the starting point for the query, excluding the file itself. Should be used for efficient pagination when working with large sets of data. learn more about pagination
cursorDirection Direction of the cursor, can be either 'before' or 'after'.
orderType Order result by ASC or DESC order.
Response
200
GET /storage/buckets/{bucketId}/files
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.list_files(bucket_id: '[BUCKET_ID]')
puts response.inspect
Create File
Create a new file. Before using this route, you should create a new bucket resource using either a server integration API or directly from your Appwrite console.
Larger files should be uploaded using multiple requests with the content-range header to send a partial request with a maximum supported chunk of 5MB
. The content-range
header values should always be in bytes.
When the first request is sent, the server will return the File object, and the subsequent part request must include the file's id in x-appwrite-id
header to allow the server to know that the partial upload is for the existing file and not for a new one.
If you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.
Request
bucketId requiredStorage bucket unique ID. You can create a new storage bucket using the Storage service server integration.
fileId requiredFile 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.
file requiredBinary file.
read An array of strings with read permissions. By default only the current user is granted with read permissions. learn more about permissions and get a full list of available permissions.
write An array of strings with write permissions. By default only the current user is granted with write permissions. learn more about permissions and get a full list of available permissions.
Response
201
POST /storage/buckets/{bucketId}/files
require 'appwrite'
client = Appwrite::Client.new
InputFile = Appwrite::InputFile
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_file(bucket_id: '[BUCKET_ID]', file_id: '[FILE_ID]', file: Appwrite::InputFile.from_path('dir/file.png'))
puts response.inspect
Get File
Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.
Request
bucketId requiredStorage bucket unique ID. You can create a new storage bucket using the Storage service server integration.
fileId requiredFile ID.
Response
200
GET /storage/buckets/{bucketId}/files/{fileId}
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.get_file(bucket_id: '[BUCKET_ID]', file_id: '[FILE_ID]')
puts response.inspect
Update File
Update a file by its unique ID. Only users with write permissions have access to update this resource.
Request
bucketId requiredStorage bucket unique ID. You can create a new storage bucket using the Storage service server integration.
fileId requiredFile unique ID.
read 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.
write 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.
Response
200
PUT /storage/buckets/{bucketId}/files/{fileId}
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.update_file(bucket_id: '[BUCKET_ID]', file_id: '[FILE_ID]')
puts response.inspect
Delete File
Delete a file by its unique ID. Only users with write permissions have access to delete this resource.
Request
bucketId requiredStorage bucket unique ID. You can create a new storage bucket using the Storage service server integration.
fileId requiredFile ID.
Response
204
DELETE /storage/buckets/{bucketId}/files/{fileId}
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.delete_file(bucket_id: '[BUCKET_ID]', file_id: '[FILE_ID]')
puts response.inspect
Get File for Download
Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.
Request
bucketId requiredStorage bucket ID. You can create a new storage bucket using the Storage service server integration.
fileId requiredFile ID.
Response
200
GET /storage/buckets/{bucketId}/files/{fileId}/download
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.get_file_download(bucket_id: '[BUCKET_ID]', file_id: '[FILE_ID]')
puts response.inspect
Get File Preview
Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.
Request
bucketId requiredStorage bucket unique ID. You can create a new storage bucket using the Storage service server integration.
fileId requiredFile ID
width Resize preview image width, Pass an integer between 0 to 4000.
height Resize preview image height, Pass an integer between 0 to 4000.
gravity Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right
quality Preview image quality. Pass an integer between 0 to 100. Defaults to 100.
borderWidth Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.
borderColor Preview image border color. Use a valid HEX color, no # is needed for prefix.
borderRadius Preview image border radius in pixels. Pass an integer between 0 to 4000.
opacity Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.
rotation Preview image rotation in degrees. Pass an integer between -360 and 360.
background Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.
output Output format type (jpeg, jpg, png, gif and webp).
Response
200
GET /storage/buckets/{bucketId}/files/{fileId}/preview
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.get_file_preview(bucket_id: '[BUCKET_ID]', file_id: '[FILE_ID]')
puts response.inspect
Get File for View
Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.
Request
bucketId requiredStorage bucket unique ID. You can create a new storage bucket using the Storage service server integration.
fileId requiredFile ID.
Response
200
GET /storage/buckets/{bucketId}/files/{fileId}/view
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.get_file_view(bucket_id: '[BUCKET_ID]', file_id: '[FILE_ID]')
puts response.inspect