Obsidian Vault REST API icon

Obsidian Vault REST API

Interact with Obsidian Vault via REST API

Overview

This node allows users to delete a file from an Obsidian Vault via its REST API. It is useful in scenarios where automated workflows need to manage files within the vault, such as cleaning up obsolete notes, removing temporary files, or managing content dynamically based on external triggers.

For example, you might use this node to automatically delete a note file when a related task is marked complete in a project management tool, ensuring your vault stays organized without manual intervention.

Properties

Name Meaning
Path The path of the file within the Obsidian Vault that you want to delete. This must be provided and specifies exactly which file will be removed.

Output

The node outputs JSON data representing the response from the Obsidian Vault REST API after attempting to delete the specified file. This typically includes confirmation of deletion or error details if the operation failed.

No binary data output is involved in this operation.

Dependencies

  • Requires access to an Obsidian Vault REST API endpoint.
  • Needs an API host URL configured in credentials or environment variables.
  • Optionally uses an API authentication token or key for authorized access to the vault.
  • The node depends on the @devlikeapro/n8n-openapi-node package for handling OpenAPI-based requests.

Troubleshooting

  • File Not Found Error: If the specified path does not exist in the vault, the API will likely return an error indicating the file was not found. Verify the path is correct and the file exists.
  • Authentication Errors: Missing or invalid API credentials will cause authorization failures. Ensure the API key or token is correctly set up.
  • Network Issues: Connection problems to the vault's API endpoint can cause timeouts or unreachable errors. Check network connectivity and API server status.
  • Permission Denied: The API user may lack permissions to delete files. Confirm the API credentials have sufficient rights.

Links and References

Discussion