5 KiB
Storage Service
List Files
GET https://appwrite.io/v1/storage/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 files. Learn more about different API modes. **
Parameters
| Field Name | Type | Description | Default |
|---|---|---|---|
| search | string | Search term to filter your list results. | |
| limit | integer | Results limit value. By default will return maximum 25 results. Maximum of 100 results allowed per request. | 25 |
| offset | integer | Results offset. The default value is 0. Use this param to manage pagination. | 0 |
| orderType | string | Order result by ASC or DESC order. | ASC |
Create File
POST https://appwrite.io/v1/storage/files
** Create a new file. The user who creates the file will automatically be assigned to read and write access unless he has passed custom values for read and write arguments. **
Parameters
| Field Name | Type | Description | Default |
|---|---|---|---|
| file | file | Binary File. | |
| read | 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. | |
| write | 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. |
Get File
GET https://appwrite.io/v1/storage/files/{fileId}
** Get file by its unique ID. This endpoint response returns a JSON object with the file metadata. **
Parameters
| Field Name | Type | Description | Default |
|---|---|---|---|
| fileId | string | Required File unique ID. |
Update File
PUT https://appwrite.io/v1/storage/files/{fileId}
** Update file by its unique ID. Only users with write permissions have access to update this resource. **
Parameters
| Field Name | Type | Description | Default |
|---|---|---|---|
| fileId | string | Required File unique ID. | |
| read | 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. | |
| write | 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. |
Delete File
DELETE https://appwrite.io/v1/storage/files/{fileId}
** Delete a file by its unique ID. Only users with write permissions have access to delete this resource. **
Parameters
| Field Name | Type | Description | Default |
|---|---|---|---|
| fileId | string | Required File unique ID. |
Get File for Download
GET https://appwrite.io/v1/storage/files/{fileId}/download
** Get 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. **
Parameters
| Field Name | Type | Description | Default |
|---|---|---|---|
| fileId | string | Required File unique ID. |
Get File Preview
GET https://appwrite.io/v1/storage/files/{fileId}/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. **
Parameters
| Field Name | Type | Description | Default |
|---|---|---|---|
| fileId | string | Required File unique ID | |
| width | integer | Resize preview image width, Pass an integer between 0 to 4000. | 0 |
| height | integer | Resize preview image height, Pass an integer between 0 to 4000. | 0 |
| quality | integer | Preview image quality. Pass an integer between 0 to 100. Defaults to 100. | 100 |
| 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). |
Get File for View
GET https://appwrite.io/v1/storage/files/{fileId}/view
** Get file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header. **
Parameters
| Field Name | Type | Description | Default |
|---|---|---|---|
| fileId | string | Required File unique ID. | |
| as | string | Choose a file format to convert your file to. Currently you can only convert word and pdf files to pdf or txt. This option is currently experimental only, use at your own risk. |