Obsidian icon

Obsidian

Interact with your Obsidian vault via the Local REST API

Overview

This node interacts with an Obsidian vault via the Local REST API, specifically to delete a file or directory within the vault. It is useful for automating file management tasks in Obsidian, such as removing outdated notes or cleaning up directories programmatically.

Use Case Examples

  1. Automatically delete old notes based on a workflow trigger.
  2. Remove temporary files or directories from the vault as part of a cleanup process.

Properties

Name Meaning
File Path Specifies the path to the file or directory to delete, relative to the vault root.
Request Options Additional options to control the request behavior, including batching, SSL certificate validation, proxy settings, and request timeout.

Output

JSON

  • success - Indicates whether the file or directory was successfully deleted.
  • message - Additional information or error message related to the delete operation.

Dependencies

  • Requires an API key credential to authenticate with the Obsidian Local REST API.

Troubleshooting

  • Ensure the file path is correct and relative to the vault root; incorrect paths will cause deletion to fail.
  • If SSL certificate validation is enabled and the server uses a self-signed certificate, enable 'Ignore SSL Issues' to avoid request failures.
  • Proxy settings must be correctly configured if a proxy is required; incorrect proxy details will prevent the request from succeeding.
  • Timeout settings should be adjusted if the server response is slow to avoid premature request abortion.

Discussion