ZAppwrite icon

ZAppwrite

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

Overview

The node integrates with Appwrite's Storage service, allowing users to manage storage buckets and files within those buckets. Specifically, the "List Files" operation retrieves a list of files stored in a specified bucket. This is useful for workflows that need to enumerate or process files stored in Appwrite, such as backing up files, syncing data, or triggering actions based on file presence.

Practical example:

  • A user wants to automate processing all files uploaded to a particular bucket by first listing them, then iterating over each file to download or analyze it.

Properties

Name Meaning
Bucket ID The unique identifier of the bucket from which to list files

Output

The output is a JSON array where each item represents a file object retrieved from the specified bucket. Each file object contains metadata about the file such as its ID, name, size, creation date, and other relevant attributes provided by Appwrite's API.

No binary data is output directly by this operation; it only returns metadata about files.

Dependencies

  • Requires an active connection to an Appwrite server.
  • Needs credentials including the Appwrite endpoint URL, project ID, and an API key credential for authentication.
  • Uses the official Appwrite SDK (node-appwrite) internally to communicate with the Appwrite Storage API.

Troubleshooting

  • Common issues:

    • Invalid or missing Bucket ID will cause the operation to fail.
    • Incorrect or expired API credentials will result in authentication errors.
    • Network connectivity problems can prevent communication with the Appwrite server.
  • Error messages:

    • Errors related to "Resource not found" may indicate the bucket does not exist or the user lacks permissions.
    • Authentication errors typically suggest invalid API keys or project IDs.
    • To resolve, verify the bucket ID exists, check credentials, and ensure network access to the Appwrite endpoint.

Links and References

Discussion