Open Vehicle Monitoring System (self-hosted) API

openapi: 3.1.0
info:
  title: Open Vehicle Monitoring System (self-hosted) API
  version: '2026-10-28'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-28: 7 operation(s) read from 4 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Open Vehicle Monitoring System (self-hosted) has published no
    machine-readable contract that the pipeline could find. Engine: anthropic.'
  x-evidence-tiers:
    code-example: 6
    documentation: 1
    pages-with-code: 2
    pages-read: 4
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-28'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://docs.openvehicles.com/en/stable/protocol_httpapi/index.html
  - https://docs.openvehicles.com/en/stable/protocol_httpapi/format.html
  - https://docs.openvehicles.com/en/stable/protocol_httpapi/authentication.html
  - https://docs.openvehicles.com/en/stable/protocol_httpapi/requests.html
servers:
- url: http://api.openvehicles.com:6868
paths:
  /api/cookie:
    delete:
      operationId: delete_api_cookie
      tags:
      - Api
      summary: DELETE /api/cookie
      x-source: https://docs.openvehicles.com/en/stable/protocol_httpapi/authentication.html
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -v -X DELETE -b cookiejar\nhttp://api.openvehicles.com:6868/api/cookie\n API Token Maintenance  \n An API token can be\
          \ created with a POST to the /api/token API endpoint: "
    get:
      operationId: get_api_cookie
      tags:
      - Api
      summary: GET /api/cookie
      x-source: https://docs.openvehicles.com/en/stable/protocol_httpapi/authentication.html
      parameters:
      - name: password
        in: query
        required: false
        schema:
          type: string
      - name: username
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: http
        snippet: 'GET /api/cookie?username=USERNAME&password=PASSWORD HTTP/1.1

          User-Agent: curl/7.24.0 (x86_64-apple-darwin12.0) libcurl/7.24.0

          OpenSSL/0.9.8r zlib/1.2.5

          Host: tmc.openvehicles.com:6868

          Accept: */*

          * HTTP 1.0, assume close after body

          < HTTP/1.0 200 Authentication ok

          < Connection: close

          < Content-Length: 9

          < Cache-Control: max-age=0

          < Content-Type: text/plain

          * Added cookie ovmsapisession="9ed66d0e-5'
  /api/status/{{VEHICLEID{url}}}:
    get:
      operationId: get_api_status_VEHICLEID_url
      tags:
      - Api
      summary: GET /api/status/{{VEHICLEID:url}}
      x-source: https://docs.openvehicles.com/en/stable/protocol_httpapi/authentication.html
      parameters:
      - name: '{VEHICLEID{url'
        in: path
        required: true
        schema:
          type: string
      - name: url
        in: path
        required: true
        schema:
          type: string
      - name: password
        in: query
        required: false
        schema:
          type: string
      - name: username
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl  --variable 'USERNAME=yourlogin'  --variable 'PASSWORD=yourpassword'  --variable 'VEHICLEID=yourvehicleid'  --expand-url\
          \  'https://api.openvehicles.com:6869/api/status/{{VEHICLEID:url}}?username={{USERNAME:url}}&password={{PASSWORD:url}}'\n By the :url\
          \ modifier curl encodes the variable values when expanding the\nURL, so you can fill the variables with your unencoded values. \n Cookie\
          \ Based Auth"
  /api/token:
    get:
      operationId: get_api_token
      tags:
      - Api
      summary: Return a list of registered API tokens.
      x-source: https://docs.openvehicles.com/en/stable/protocol_httpapi/requests.html
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_token
      tags:
      - Api
      summary: POST /api/token
      x-source: https://docs.openvehicles.com/en/stable/protocol_httpapi/authentication.html
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -v -X POST -F 'application=<app>' -F 'purpose=<purpose>' -F 'permit=<permit>'\nhttp://api.openvehicles.com:6868/api/token\n\
          \ Note that the ‘purpose’ and ‘application’ fields are comments attached to the token and are\nintended to identify the application\
          \ that created/uses the token and the purpose that\ntoken is used for. \n The ‘permit’ field defines the list of rights granted to the\
          \ user of this "
  /api/token/{token}:
    delete:
      operationId: delete_api_token_token
      tags:
      - Api
      summary: DELETE /api/token/{token}
      x-source: https://docs.openvehicles.com/en/stable/protocol_httpapi/authentication.html
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -v -X DELETE http://api.openvehicles.com:6868/api/token/<TOKEN>\n Previous \n Next \n © Copyright 2019-2024, Open Vehicles\
          \ Developers. \n Built with Sphinx using a\n theme \n provided by Read the Docs ."
  /api/vehicles:
    get:
      operationId: get_api_vehicles
      tags:
      - Api
      summary: GET /api/vehicles
      x-source: https://docs.openvehicles.com/en/stable/protocol_httpapi/format.html
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -v -X GET -b cookiejar http://api.openvehicles.com:6868/api/vehicles\n* About to connect() to api.openvehicles.com port\
          \ 6868 (#0)\n* Trying api.openvehicles.com....\n* connected\n* Connected to tmc.openvehicles.com (64.111.70.40) port 6868 (#0)\n> GET\
          \ /api/vehicles HTTP/1.1\nUser-Agent: curl/7.24.0 (x86_64-apple-darwin12.0) libcurl/7.24.0\nOpenSSL/0.9.8r zlib/1.2.5\nHost: api.openvehicles.com:6868\n\
          \ A"
tags:
- name: Api