Storage API Reference - Docs

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 Tables 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.

Base URL

https://<REGION>.cloud.appwrite.io/v1

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 string
  required
  
  Storage bucket unique ID. You can create a new storage bucket using the Storage service server integration.
- fileId string
  required
  
  File ID. Choose a custom ID or generate a random ID with ID.unique(). 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 string
  required
  
  Binary file. Appwrite SDKs provide helpers to handle file input. Learn about file input.
- permissions array
  
  An array of permission strings. By default, only the current user is granted all permissions. Learn more about permissions.
Response
- 201 application/json
  
  File
Rate limits

This endpoint is rate limited. You can only make a limited number of request to his endpoint within a specific time frame.

The limit is applied for each unique limit key.

Time frame
Attempts
Key
1 minutes 60 requests IP + METHOD + URL + USER ID +

Learn more about rate limits

Time frame	Attempts	Key
1 minutes	60 requests	IP + METHOD + URL + USER ID +

Endpoint

POST /storage/buckets/{bucketId}/files

Web

import { Client, Storage, Permission, Role } from "appwrite";

const client = new Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>'); // Your project ID

const storage = new Storage(client);

const result = await storage.createFile({
    bucketId: '<BUCKET_ID>',
    fileId: '<FILE_ID>',
    file: document.getElementById('uploader').files[0],
    permissions: [Permission.read(Role.any())] // optional
});

console.log(result);

Get file

Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.

Request
- bucketId string
  required
  
  Storage bucket unique ID. You can create a new storage bucket using the Storage service server integration.
- fileId string
  required
  
  File ID.
Response
- 200 application/json
  
  File

Endpoint

GET /storage/buckets/{bucketId}/files/{fileId}

Web

import { Client, Storage } from "appwrite";

const client = new Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>'); // Your project ID

const storage = new Storage(client);

const result = await storage.getFile({
    bucketId: '<BUCKET_ID>',
    fileId: '<FILE_ID>'
});

console.log(result);

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 string
  required
  
  Storage bucket ID. You can create a new storage bucket using the Storage service server integration.
- fileId string
  required
  
  File ID.
- token string
  
  File token for accessing this file.
Response
- 200 no content

Endpoint

GET /storage/buckets/{bucketId}/files/{fileId}/download

Web

import { Client, Storage } from "appwrite";

const client = new Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>'); // Your project ID

const storage = new Storage(client);

const result = storage.getFileDownload({
    bucketId: '<BUCKET_ID>',
    fileId: '<FILE_ID>',
    token: '<TOKEN>' // optional
});

console.log(result);

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 string
  required
  
  Storage bucket unique ID. You can create a new storage bucket using the Storage service server integration.
- fileId string
  required
  
  File ID.
- token string
  
  File token for accessing this file.
Response
- 200 no content

Endpoint

GET /storage/buckets/{bucketId}/files/{fileId}/view

Web

import { Client, Storage } from "appwrite";

const client = new Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>'); // Your project ID

const storage = new Storage(client);

const result = storage.getFileView({
    bucketId: '<BUCKET_ID>',
    fileId: '<FILE_ID>',
    token: '<TOKEN>' // optional
});

console.log(result);

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 string
  required
  
  Storage bucket unique ID. You can create a new storage bucket using the Storage service server integration.
- fileId string
  required
  
  File ID
- width integer
  
  Resize preview image width, Pass an integer between 0 to 4000.
- height integer
  
  Resize preview image height, Pass an integer between 0 to 4000.
- gravity string
  
  Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right
- quality integer
  
  Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
- borderWidth integer
  
  Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.
- borderColor string
  
  Preview image border color. Use a valid HEX color, no # is needed for prefix.
- borderRadius integer
  
  Preview image border radius in pixels. Pass an integer between 0 to 4000.
- opacity number
  
  Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.
- rotation integer
  
  Preview image rotation in degrees. Pass an integer between -360 and 360.
- background string
  
  Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.
- output string
  
  Output format type (jpeg, jpg, png, gif and webp).
- token string
  
  File token for accessing this file.
Response
- 200 no content

Endpoint

GET /storage/buckets/{bucketId}/files/{fileId}/preview

Web

import { Client, Storage, ImageGravity, ImageFormat } from "appwrite";

const client = new Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>'); // Your project ID

const storage = new Storage(client);

const result = storage.getFilePreview({
    bucketId: '<BUCKET_ID>',
    fileId: '<FILE_ID>',
    width: 0, // optional
    height: 0, // optional
    gravity: ImageGravity.Center, // optional
    quality: -1, // optional
    borderWidth: 0, // optional
    borderColor: '', // optional
    borderRadius: 0, // optional
    opacity: 0, // optional
    rotation: -360, // optional
    background: '', // optional
    output: ImageFormat.Jpg, // optional
    token: '<TOKEN>' // optional
});

console.log(result);

List files

Get a list of all the user files. You can use the query params to filter your results.

Request
- bucketId string
  required
  
  Storage bucket unique ID. You can create a new storage bucket using the Storage service server integration.
- queries array
  
  Array of query strings generated using the Query class provided by the SDK. Learn more about queries. Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded
- search string
  
  Search term to filter your list results. Max length: 256 chars.
Response
- 200 application/json
  
  Files List

Endpoint

GET /storage/buckets/{bucketId}/files

Web

import { Client, Storage } from "appwrite";

const client = new Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>'); // Your project ID

const storage = new Storage(client);

const result = await storage.listFiles({
    bucketId: '<BUCKET_ID>',
    queries: [], // optional
    search: '<SEARCH>' // optional
});

console.log(result);

Update file

Update a file by its unique ID. Only users with write permissions have access to update this resource.

Request
- bucketId string
  required
  
  Storage bucket unique ID. You can create a new storage bucket using the Storage service server integration.
- fileId string
  required
  
  File unique ID.
- name string
  
  Name of the file
- permissions array
  
  An array of permission string. By default, the current permissions are inherited. Learn more about permissions.
Response
- 200 application/json
  
  File
Rate limits

This endpoint is rate limited. You can only make a limited number of request to his endpoint within a specific time frame.

The limit is applied for each unique limit key.

Time frame
Attempts
Key
1 minutes 60 requests IP + METHOD + URL + USER ID

Learn more about rate limits

Time frame	Attempts	Key
1 minutes	60 requests	IP + METHOD + URL + USER ID

Endpoint

PUT /storage/buckets/{bucketId}/files/{fileId}

Web

import { Client, Storage, Permission, Role } from "appwrite";

const client = new Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>'); // Your project ID

const storage = new Storage(client);

const result = await storage.updateFile({
    bucketId: '<BUCKET_ID>',
    fileId: '<FILE_ID>',
    name: '<NAME>', // optional
    permissions: [Permission.read(Role.any())] // optional
});

console.log(result);

Delete file

Delete a file by its unique ID. Only users with write permissions have access to delete this resource.

Request
- bucketId string
  required
  
  Storage bucket unique ID. You can create a new storage bucket using the Storage service server integration.
- fileId string
  required
  
  File ID.
Response
- 204 no content
Rate limits

This endpoint is rate limited. You can only make a limited number of request to his endpoint within a specific time frame.

The limit is applied for each unique limit key.

Time frame
Attempts
Key
1 minutes 60 requests IP + METHOD + URL + USER ID

Learn more about rate limits

Time frame	Attempts	Key
1 minutes	60 requests	IP + METHOD + URL + USER ID

Endpoint

DELETE /storage/buckets/{bucketId}/files/{fileId}

Web

import { Client, Storage } from "appwrite";

const client = new Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>'); // Your project ID

const storage = new Storage(client);

const result = await storage.deleteFile({
    bucketId: '<BUCKET_ID>',
    fileId: '<FILE_ID>'
});

console.log(result);

Recommended