Appwrite icon

Appwrite

A comprehensive node for the Appwrite API

Overview

This node integrates with the Appwrite API to manage storage buckets and files. Specifically, the "Delete Bucket" operation under the "Storage" resource allows users to delete a storage bucket by specifying its unique ID. This is useful for cleaning up unused or obsolete storage containers in an Appwrite project.

Practical scenarios include:

  • Automating cleanup of temporary or test storage buckets.
  • Managing storage lifecycle by programmatically deleting buckets no longer needed.
  • Integrating with workflows that provision and decommission storage resources dynamically.

Properties

Name Meaning
Bucket ID Unique identifier of the storage bucket to operate on. For deletion, this specifies which bucket to delete. Use "unique()" to auto-generate when creating buckets.

Output

The output JSON object for the "Delete Bucket" operation contains a single field:

  • success: A boolean indicating whether the bucket was successfully deleted (true).

Example output JSON:

{
  "success": true
}

No binary data is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Appwrite API.
  • The node depends on the Appwrite client library internally to perform API calls.
  • Proper permissions must be granted to the API key to allow bucket deletion.
  • No additional environment variables are required beyond the configured API credentials.

Troubleshooting

  • Common issues:

    • Attempting to delete a non-existent bucket will likely result in an error from the Appwrite API.
    • Insufficient permissions on the API key can cause authorization errors.
    • Providing an invalid or empty Bucket ID will cause the operation to fail.
  • Error messages:

    • Errors returned from the Appwrite API are propagated and wrapped as node errors.
    • If the node fails, check the error message for details such as "bucket not found" or "permission denied".
    • To resolve, verify the Bucket ID is correct and that the API key has appropriate access rights.

Links and References

Discussion