n8n-nodes-obsidian-rest
v1.0.3
Published
n8n community node for Obsidian Local REST API - A complete integration for managing Obsidian vault via REST API
Maintainers
Readme
n8n-nodes-obsidian-rest
This is an n8n community node for interacting with Obsidian via the Local REST API plugin.
n8n is a fair-code licensed workflow automation platform.
Features
- Vault Files: List, read, create, update, append, and delete files in your vault
- Active File: Manage the currently active file in Obsidian
- Search: Simple search and Dataview DQL queries
- Commands: List and execute Obsidian commands
- Periodic Notes: Manage daily, weekly, monthly, quarterly, and yearly notes
- System: Get API server status
Prerequisites
- Install the Obsidian Local REST API plugin in Obsidian
- Enable the plugin and note your API key from settings
Installation
Community Nodes (Recommended)
- Go to Settings > Community Nodes
- Select Install
- Enter
n8n-nodes-obsidian-rest - Click Install
Manual Installation
cd ~/.n8n/nodes
npm install n8n-nodes-obsidian-restConfiguration
After installation, create credentials:
- Go to Credentials
- Create new Obsidian Local REST API credentials
- Enter your:
- Base URL:
https://127.0.0.1:27124(or your tunneled URL) - API Key: Your API key from Obsidian settings
- Ignore SSL Issues: Enable if using self-signed certificates
- Base URL:
Operations
Vault File
| Operation | Description | |-----------|-------------| | List Files | List files in a directory | | Read File | Read file content (raw or JSON with metadata) | | Create/Update File | Create new file or update existing | | Append to File | Append content to a file | | Delete File | Delete a file |
Active File
| Operation | Description | |-----------|-------------| | Get | Get content of the active file | | Update | Replace content of the active file | | Append | Append content to the active file | | Delete | Delete the active file |
Search
| Operation | Description | |-----------|-------------| | Simple Search | Search using text query | | Dataview Query | Search using Dataview DQL |
Command
| Operation | Description | |-----------|-------------| | List Commands | List all available commands | | Execute Command | Execute a specific command |
Periodic Note
| Operation | Description | |-----------|-------------| | Get | Get current periodic note | | Update | Update periodic note content | | Append | Append to periodic note |
Remote Access
To access Obsidian from a remote n8n instance, you can use:
License
MIT
