Actions23
- Files Actions
- Notes Actions
- Metadata Actions
- Vault Actions
- Agent Actions
Overview
The node interacts with an Obsidian Vault via its REST API, specifically providing the ability to list the contents of a directory within the vault. This operation is useful for workflows that need to explore or process files and folders stored in an Obsidian Vault programmatically. For example, you might use this node to retrieve all notes in a specific folder, optionally including subfolders, to automate content analysis, backup, or synchronization tasks.
Properties
| Name | Meaning |
|---|---|
| Path | The directory path inside the vault to list. Defaults to the root directory ".". |
| Recursive | Whether to list files recursively through all subdirectories (true or false). |
| Limit | Maximum number of items to return in one response (pagination limit). |
| Offset | Number of items to skip before starting to collect the result set (pagination offset). |
Output
The node outputs JSON data representing the directory listing retrieved from the Obsidian Vault. Each item in the output typically corresponds to a file or folder entry, including metadata such as name, type, and possibly other attributes depending on the API response. The output does not include binary data; it is purely structured JSON describing the directory contents.
Dependencies
- Requires access to an Obsidian Vault REST API endpoint.
- Needs configuration of credentials containing the host URL and an optional API authentication token.
- The node uses standard HTTP requests with JSON payloads and expects the API to support query parameters for path, recursive listing, limit, and offset.
Troubleshooting
- Common issues:
- Incorrect or unreachable Vault API host URL will cause connection failures.
- Insufficient permissions or missing authentication may lead to authorization errors.
- Providing an invalid path could result in empty results or error responses.
- Error messages:
- Network errors indicate connectivity problems; verify the Vault API URL and network access.
- Authorization errors suggest missing or incorrect API credentials.
- Invalid parameter errors mean the input properties (e.g., path) do not conform to expected formats.
Links and References
- Obsidian Vault REST API Documentation (example link, replace with actual if available)
- n8n documentation on HTTP Request Node for understanding underlying request mechanics