Go to Console
Star on GitHub 45.1K Get started

Storage

SERVER

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.

Base URL
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
    • 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: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus

    • search string

      Search term to filter your list results. Max length: 256 chars.

  • Response
Endpoint
GET /storage/buckets
Node.js
const sdk = require('node-appwrite');

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

const storage = new sdk.Storage(client);

const result = await storage.listBuckets(
    [], // queries (optional)
    '<SEARCH>' // search (optional)
);

Create bucket

Create a new storage bucket.

  • Request
    • bucketId string
      required

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

    • name string
      required

      Bucket name

    • fileSecurity boolean

      Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. Learn more about permissions.

    • enabled boolean

      Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.

    • maximumFileSize integer

      Maximum file size allowed in bytes. Maximum allowed value is 30MB.

    • allowedFileExtensions array

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

    • compression string

      Compression algorithm choosen for compression. Can be one of none, gzip, or zstd, For file size above 20MB compression is skipped even if it's enabled

    • encryption boolean

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

    • antivirus boolean

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

  • Response
Endpoint
POST /storage/buckets
Node.js
const sdk = require('node-appwrite');

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

const storage = new sdk.Storage(client);

const result = await storage.createBucket(
    '<BUCKET_ID>', // bucketId
    '<NAME>', // name
    ["read("any")"], // permissions (optional)
    false, // fileSecurity (optional)
    false, // enabled (optional)
    1, // maximumFileSize (optional)
    [], // allowedFileExtensions (optional)
    sdk..None, // compression (optional)
    false, // encryption (optional)
    false // antivirus (optional)
);

Get bucket

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

  • Request
    • bucketId string
      required

      Bucket unique ID.

  • Response
Endpoint
GET /storage/buckets/{bucketId}
Node.js
const sdk = require('node-appwrite');

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

const storage = new sdk.Storage(client);

const result = await storage.getBucket(
    '<BUCKET_ID>' // bucketId
);

Update bucket

Update a storage bucket by its unique ID.

  • Request
    • bucketId string
      required

      Bucket unique ID.

    • name string
      required

      Bucket name

    • fileSecurity boolean

      Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. Learn more about permissions.

    • enabled boolean

      Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.

    • maximumFileSize integer

      Maximum file size allowed in bytes. Maximum allowed value is 30MB.

    • allowedFileExtensions array

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

    • compression string

      Compression algorithm choosen for compression. Can be one of none, gzip, or zstd, For file size above 20MB compression is skipped even if it's enabled

    • encryption boolean

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

    • antivirus boolean

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

  • Response
Endpoint
PUT /storage/buckets/{bucketId}
Node.js
const sdk = require('node-appwrite');

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

const storage = new sdk.Storage(client);

const result = await storage.updateBucket(
    '<BUCKET_ID>', // bucketId
    '<NAME>', // name
    ["read("any")"], // permissions (optional)
    false, // fileSecurity (optional)
    false, // enabled (optional)
    1, // maximumFileSize (optional)
    [], // allowedFileExtensions (optional)
    sdk..None, // compression (optional)
    false, // encryption (optional)
    false // antivirus (optional)
);

Delete bucket

Delete a storage bucket by its unique ID.

  • Request
    • bucketId string
      required

      Bucket unique ID.

  • Response
    • 204 application/json
Endpoint
DELETE /storage/buckets/{bucketId}
Node.js
const sdk = require('node-appwrite');

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

const storage = new sdk.Storage(client);

const result = await storage.deleteBucket(
    '<BUCKET_ID>' // bucketId
);

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
Endpoint
GET /storage/buckets/{bucketId}/files
Node.js
const sdk = require('node-appwrite');

const client = new sdk.Client()
    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>') // Your project ID
    .setSession(''); // The user session to authenticate with

const storage = new sdk.Storage(client);

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

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
  • Rate limits

    This endpoint is not limited when using Server SDKs with API keys. If you are using SSR with setSession, these rate limits will still apply. Learn more about SSR rate limits.

    The limit is applied for each unique limit key.

    Time frame
    Attempts
    Key
    1 minutes 60 requests IP + METHOD + URL + USER ID +
Endpoint
POST /storage/buckets/{bucketId}/files
Node.js
const sdk = require('node-appwrite');
const fs = require('fs');

const client = new sdk.Client()
    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>') // Your project ID
    .setSession(''); // The user session to authenticate with

const storage = new sdk.Storage(client);

const result = await storage.createFile(
    '<BUCKET_ID>', // bucketId
    '<FILE_ID>', // fileId
    InputFile.fromPath('/path/to/file', 'filename'), // file
    ["read("any")"] // permissions (optional)
);

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
Endpoint
GET /storage/buckets/{bucketId}/files/{fileId}
Node.js
const sdk = require('node-appwrite');

const client = new sdk.Client()
    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>') // Your project ID
    .setSession(''); // The user session to authenticate with

const storage = new sdk.Storage(client);

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

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

  • Response
    • 200 application/json
  • Rate limits

    This endpoint is not limited when using Server SDKs with API keys. If you are using SSR with setSession, these rate limits will still apply. Learn more about SSR rate limits.

    The limit is applied for each unique limit key.

    Time frame
    Attempts
    Key
    1 minutes 60 requests IP + METHOD + URL + USER ID
Endpoint
PUT /storage/buckets/{bucketId}/files/{fileId}
Node.js
const sdk = require('node-appwrite');

const client = new sdk.Client()
    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>') // Your project ID
    .setSession(''); // The user session to authenticate with

const storage = new sdk.Storage(client);

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

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 application/json
  • Rate limits

    This endpoint is not limited when using Server SDKs with API keys. If you are using SSR with setSession, these rate limits will still apply. Learn more about SSR rate limits.

    The limit is applied for each unique limit key.

    Time frame
    Attempts
    Key
    1 minutes 60 requests IP + METHOD + URL + USER ID
Endpoint
DELETE /storage/buckets/{bucketId}/files/{fileId}
Node.js
const sdk = require('node-appwrite');

const client = new sdk.Client()
    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>') // Your project ID
    .setSession(''); // The user session to authenticate with

const storage = new sdk.Storage(client);

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

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.

  • Response
    • 200 application/json
Endpoint
GET /storage/buckets/{bucketId}/files/{fileId}/download
Node.js
const sdk = require('node-appwrite');

const client = new sdk.Client()
    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>') // Your project ID
    .setSession(''); // The user session to authenticate with

const storage = new sdk.Storage(client);

const result = await storage.getFileDownload(
    '<BUCKET_ID>', // bucketId
    '<FILE_ID>' // fileId
);

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

    • 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).

  • Response
    • 200 application/json
Endpoint
GET /storage/buckets/{bucketId}/files/{fileId}/preview
Node.js
const sdk = require('node-appwrite');

const client = new sdk.Client()
    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>') // Your project ID
    .setSession(''); // The user session to authenticate with

const storage = new sdk.Storage(client);

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

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.

  • Response
    • 200 application/json
Endpoint
GET /storage/buckets/{bucketId}/files/{fileId}/view
Node.js
const sdk = require('node-appwrite');

const client = new sdk.Client()
    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>') // Your project ID
    .setSession(''); // The user session to authenticate with

const storage = new sdk.Storage(client);

const result = await storage.getFileView(
    '<BUCKET_ID>', // bucketId
    '<FILE_ID>' // fileId
);
Copyright © 2024 Appwrite