Obsidian System API

The System API from Obsidian — 3 operation(s) for system.

Operations 3

GET / Returns basic details about the server #
GET /obsidian-local-rest-api.crt Returns the certificate in use by this API #
GET /openapi.yaml Returns OpenAPI YAML document describing the capabilities of this API #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/obsidian-system-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

obsidian-system-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: You can use this interface for trying out your Local REST API in Obsidian.
  title: Local REST API for Obsidian System API
  version: '1.0'
servers:
- description: HTTPS (Secure Mode)
  url: https://{host}:{port}
  variables:
    host:
      default: 127.0.0.1
      description: Binding host
    port:
      default: '27124'
      description: HTTPS port
- description: HTTP (Insecure Mode)
  url: http://{host}:{port}
  variables:
    host:
      default: 127.0.0.1
      description: Binding host
    port:
      default: '27123'
      description: HTTP port
security:
- apiKeyAuth: []
tags:
- name: System
paths:
  /:
    get:
      description: 'Returns basic details about the server as well as your authentication status.


        This is the only API request that does *not* require authentication.'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  authenticated:
                    description: Is your current request authenticated?
                    type: boolean
                  ok:
                    description: '''OK'''
                    type: string
                  service:
                    description: '''Obsidian Local REST API'''
                    type: string
                  versions:
                    properties:
                      obsidian:
                        description: Obsidian plugin API version
                        type: string
                      self:
                        description: Plugin version.
                        type: string
                    type: object
                type: object
          description: Success
      summary: Returns basic details about the server
      tags:
      - System
      operationId: getRoot
      x-operation-id-source: derived
  /obsidian-local-rest-api.crt:
    get:
      responses:
        '200':
          description: Success
      summary: Returns the certificate in use by this API
      tags:
      - System
      operationId: getObsidianLocalRestApiCrt
      x-operation-id-source: derived
  /openapi.yaml:
    get:
      responses:
        '200':
          description: Success
      summary: Returns OpenAPI YAML document describing the capabilities of this API
      tags:
      - System
      operationId: getOpenapiYaml
      x-operation-id-source: derived
components:
  securitySchemes:
    apiKeyAuth:
      description: 'Find your API Key in your Obsidian settings

        in the "Local REST API" section under "Plugins".

        '
      scheme: bearer
      type: http