{ "opencollection": "1.0.0", "info": { "name": "Local REST API for Obsidian Active File Vault Files API", "version": "1.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Vault Files", "type": "folder" }, "items": [ { "info": { "name": "Return the content of a single file in your vault.\n", "type": "http" }, "http": { "method": "GET", "url": "https://{host}:{port}/vault/:filename", "headers": [ { "name": "Target-Type", "value": "" }, { "name": "Target", "value": "" }, { "name": "Target-Delimiter", "value": "" } ], "params": [ { "name": "filename", "value": "", "type": "path", "description": "Path to the relevant file (relative to your vault root).\n Optionally, you may include a reference to a sub-part of the document to return; see \"Targeting a Sub-part of your Document\" for details." } ] }, "docs": "Returns the content of the file at the specified path in your vault should the file exist.\n\n# Targeting a Sub-part of your Document\n\nYou can operate on a specific section of a note instead of the whole file by providing `Target-Type` and `Target` headers:\n\n- Set `Target-Type` to `heading`, `block`, or `frontmatter`.\n- Set `Target` to the name of the heading, block reference, or frontmatter field. If the target contains non-ASCII characters (e.g. accented letters), percent-encode the value (e.g. " }, { "info": { "name": "Append content to a new or existing file.\n", "type": "http" }, "http": { "method": "POST", "url": "https://{host}:{port}/vault/:filename", "headers": [ { "name": "Create-Target-If-Missing", "value": "" }, { "name": "Apply-If-Content-Preexists", "value": "" }, { "name": "Trim-Target-Whitespace", "value": "" }, { "name": "Target-Type", "value": "" }, { "name": "Target", "value": "" }, { "name": "Target-Delimiter", "value": "" } ], "params": [ { "name": "filename", "value": "", "type": "path", "description": "Path to the relevant file (relative to your vault root).\n Optionally, you may include a reference to a sub-part of the document to return; see \"Targeting a Sub-part of your Document\" for details." } ] }, "docs": "Appends content to the end of an existing note. If the specified file does not yet exist, it will be created as an empty file.\n\n# Targeting a Sub-part of your Document\n\nYou can operate on a specific section of a note instead of the whole file by providing `Target-Type` and `Target` headers:\n\n- Set `Target-Type` to `heading`, `block`, or `frontmatter`.\n- Set `Target` to the name of the heading, block reference, or frontmatter field. If the target contains non-ASCII characters (e.g. accented lette" }, { "info": { "name": "Create a new file in your vault or update the content of an existing one.\n", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}:{port}/vault/:filename", "headers": [ { "name": "Apply-If-Content-Preexists", "value": "" }, { "name": "Trim-Target-Whitespace", "value": "" }, { "name": "Target-Type", "value": "" }, { "name": "Target", "value": "" }, { "name": "Target-Delimiter", "value": "" } ], "params": [ { "name": "filename", "value": "", "type": "path", "description": "Path to the relevant file (relative to your vault root).\n Optionally, you may include a reference to a sub-part of the document to return; see \"Targeting a Sub-part of your Document\" for details." } ] }, "docs": "Creates a new file in your vault or updates the content of an existing one if the specified file already exists.\n\n# Targeting a Sub-part of your Document\n\nYou can operate on a specific section of a note instead of the whole file by providing `Target-Type` and `Target` headers:\n\n- Set `Target-Type` to `heading`, `block`, or `frontmatter`.\n- Set `Target` to the name of the heading, block reference, or frontmatter field. If the target contains non-ASCII characters (e.g. accented letters), percent-e" }, { "info": { "name": "Partially update content in an existing note.\n", "type": "http" }, "http": { "method": "PATCH", "url": "https://{host}:{port}/vault/:filename", "headers": [ { "name": "Operation", "value": "" }, { "name": "Create-Target-If-Missing", "value": "" }, { "name": "Apply-If-Content-Preexists", "value": "" }, { "name": "Trim-Target-Whitespace", "value": "" }, { "name": "Target-Type", "value": "" }, { "name": "Target", "value": "" }, { "name": "Target-Delimiter", "value": "" } ], "params": [ { "name": "filename", "value": "", "type": "path", "description": "Path to the relevant file (relative to your vault root).\n Optionally, you may include a reference to a sub-part of the document to return; see \"Targeting a Sub-part of your Document\" for details." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Inserts content into an existing note relative to a heading, block reference, or frontmatter field within that document.\n\nAllows you to modify the content relative to a heading, block reference, or frontmatter field in your document.\n\n> ![note]\n> Note that this API was changed in Version 3.0 of this extension and the earlier PATCH API is now deprecated. Requests made using the previous version of this API will continue to work until Version 4.0 is released. See https://github.com/coddingtonbear" }, { "info": { "name": "Delete a particular file in your vault.\n", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}:{port}/vault/:filename", "params": [ { "name": "filename", "value": "", "type": "path", "description": "Path to the relevant file (relative to your vault root).\n Optionally, you may include a reference to a sub-part of the document to return; see \"Targeting a Sub-part of your Document\" for details." } ] }, "docs": "Delete a particular file in your vault.\n" } ] } ], "bundled": true }