Obsidian Vault REST API icon

Obsidian Vault REST API

Interact with Obsidian Vault via REST API
Join our community

Actions23

Overview

This node interacts with an Obsidian Vault via its REST API, specifically to list metadata values associated with a given key. It is useful when you want to retrieve all the values stored under a particular metadata key in your Obsidian Vault, enabling automation workflows that depend on metadata querying.

Practical examples include:

  • Fetching all tags or categories assigned to notes.
  • Retrieving custom metadata fields for filtering or reporting.
  • Integrating Obsidian metadata into other systems or dashboards.

Properties

Name Meaning
Key The metadata key whose values you want to list. This is a required string input specifying which metadata field to query in the Obsidian Vault.

Output

The node outputs JSON data containing the list of metadata values corresponding to the specified key. The exact structure depends on the API response but generally includes an array of values related to that metadata key.

No binary data output is indicated by the source code.

Dependencies

  • Requires access to an Obsidian Vault REST API endpoint.
  • Needs configuration of credentials providing the API host URL and authentication token (API key or similar).
  • The node uses HTTP requests to communicate with the Obsidian Vault API.

Troubleshooting

  • Common issues:

    • Incorrect or missing API host URL or authentication credentials will cause connection failures.
    • Providing a non-existent or misspelled metadata key will likely return empty results or errors.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • Authentication errors indicate invalid or missing API tokens; verify credential setup.
    • 404 or "Not Found" errors suggest the metadata key does not exist; check the key spelling.
    • Timeout errors may require increasing timeout settings or checking network stability.

Links and References

Discussion