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 to list files within a specified directory path. It is useful for workflows that need to retrieve and process files stored in an Obsidian vault, such as automating file management, backups, or content analysis. For example, you can list all files in a 'CRM/Contacts/' directory to automate contact data extraction or synchronization.

Use Case Examples

  1. List all files in the root directory of the vault.
  2. List files in a specific subdirectory like 'CRM/Contacts/' to process or analyze them.

Properties

Name Meaning
Directory Path Specifies the path within the vault to list files from. If left empty, the root of the vault is used.
Request Options Additional options to control the request behavior, including batching, SSL certificate validation, proxy settings, and request timeout.

Output

JSON

  • files - An array of file objects representing the files listed from the specified directory path in the vault.

Dependencies

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

Troubleshooting

  • If the node fails to connect, verify the API credentials and ensure the Obsidian Local REST API is running and accessible.
  • Timeout errors may occur if the server is slow or unresponsive; increase the timeout setting if needed.
  • SSL certificate validation errors can be bypassed by enabling the 'Ignore SSL Issues' option, but this reduces security.
  • Proxy configuration errors can prevent requests from succeeding; ensure proxy settings are correct if used.

Links

Discussion