Obsidian Vault REST API icon

Obsidian Vault REST API

Interact with Obsidian Vault via REST API

Overview

This node allows users to bulk delete notes in an Obsidian Vault via its REST API. It is designed for scenarios where multiple notes need to be removed at once, streamlining the process and saving time compared to deleting notes individually. For example, if you have a list of obsolete or archived notes identified by their paths, you can pass them all at once to this node to delete them efficiently.

Properties

Name Meaning
Paths A JSON array containing the paths of the notes to be deleted. Each element should specify the path of a note to remove.

Output

The node outputs JSON data representing the response from the Obsidian Vault REST API after attempting to delete the specified notes. This typically includes confirmation of deletion status for each note path provided. The output does not include binary data.

Dependencies

  • Requires access to an Obsidian Vault REST API endpoint.
  • Needs an API host URL configured in credentials or environment variables.
  • May require an API authentication token or key depending on the Obsidian Vault API setup.

Troubleshooting

  • Invalid Paths Format: Ensure that the "Paths" property is a valid JSON array of strings representing note paths. Malformed JSON or incorrect data types will cause errors.
  • API Connection Issues: Verify that the API host URL is correct and reachable. Network issues or incorrect URLs will prevent successful requests.
  • Authentication Failures: If the API requires authentication, ensure that the necessary credentials or tokens are correctly configured.
  • Partial Deletions: If some notes fail to delete, check the API response for error messages related to specific paths, such as non-existent files or permission issues.

Links and References

Discussion