NAppwrite icon

NAppwrite

Use Appwrite's API from inside N8N, updated by @ZachHandley
Join our community

Actions25

Overview

This node integrates with Appwrite's Storage service, allowing users to manage files and buckets within their Appwrite project. Specifically, the "List Files" operation retrieves all files stored in a specified bucket. This is useful for workflows that need to display, process, or manipulate files stored remotely.

Common scenarios include:

  • Automating file management by listing files in a bucket before processing them.
  • Creating dashboards or reports showing current files in storage.
  • Triggering downstream actions based on the presence or attributes of files in a bucket.

Example: A user wants to list all images uploaded to a specific bucket to generate thumbnails or archive old files.

Properties

Name Meaning
Bucket ID The unique identifier of the storage bucket from which to list files. This is required to specify the target bucket.

Output

The node outputs a JSON array where each element represents a file object retrieved from the specified bucket. Each file object typically contains metadata such as file ID, name, size, creation date, and other relevant attributes provided by Appwrite's storage API.

If the node supports binary data output (not explicitly shown here), it would represent actual file contents; however, for the "List Files" operation, only metadata is returned.

Dependencies

  • Requires an active Appwrite project with configured storage buckets.
  • Needs credentials including the Appwrite endpoint URL, project ID, and an API key or authentication token with permissions to access storage.
  • The node depends on the node-appwrite SDK and internal helper functions to communicate with the Appwrite API.

Troubleshooting

  • Invalid Bucket ID: If the bucket ID does not exist or is incorrect, the node will likely throw an error indicating the bucket was not found. Verify the bucket ID is correct.
  • Authentication Errors: Missing or invalid API keys or project IDs will cause authentication failures. Ensure credentials are correctly set up in n8n.
  • Permission Denied: The API key used must have sufficient permissions to list files in the bucket.
  • Empty Results: If no files are listed, confirm that the bucket contains files and that filters (if any) are not excluding results.

Links and References

Discussion