evcc (self-hosted) System API

openapi: 3.2.0
info:
  title: evcc System API
  description: smart charging. open source energy management.
  version: 0.2.0
  contact:
    url: https://github.com/evcc-io/evcc
servers:
- url: https://demo.evcc.io/api
tags:
- name: System
paths:
  /settings/telemetry/{enable}:
    post:
      operationId: setTelemetryStatus
      summary: Enable/disable telemetry
      description: 'Enable or disable telemetry. Note: Telemetry requires sponsorship.'
      externalDocs:
        url: https://docs.evcc.io/en/reference/configuration/telemetry
      tags:
      - System
      parameters:
      - $ref: '#/components/parameters/enable'
      responses:
        '200':
          $ref: '#/components/responses/BooleanResult'
        '400':
          description: Sponsorship required
  /system/log:
    get:
      operationId: getSystemLogs
      summary: Logs
      description: Returns the latest log lines.
      externalDocs:
        url: https://docs.evcc.io/en/reference/configuration/log
      security:
      - cookieAuth: []
      - bearerAuth: []
      tags:
      - System
      parameters:
      - $ref: '#/components/parameters/logAreas'
      - $ref: '#/components/parameters/logLevel'
      - name: count
        in: query
        description: Number of log lines to return
        example: 100
        schema:
          type: integer
      - name: format
        in: query
        description: File type
        schema:
          type: string
          enum:
          - txt
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
            text/plain:
              schema:
                description: Download txt-file
                type: string
                format: binary
        '401':
          $ref: '#/components/responses/Unauthorized'
  /system/log/areas:
    get:
      operationId: getLogAreas
      summary: List of all log areas
      description: Returns a list of all log areas (e.g. `lp-1`, `site`, `db`).
      security:
      - cookieAuth: []
      - bearerAuth: []
      tags:
      - System
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogAreas'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /system/cache:
    delete:
      operationId: clearCache
      summary: Clear cache
      description: Clears all cached data. This resets all cached values from tariffs, vehicle APIs, and other components that use caching.
      security:
      - cookieAuth: []
      - bearerAuth: []
      tags:
      - System
      responses:
        '200':
          $ref: '#/components/responses/SuccessResult'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /system/shutdown:
    post:
      operationId: shutdownSystem
      summary: Shutdown evcc
      description: Shut down instance. There is no reboot command. We expect the underlying system (docker, systemd, etc.) to restart the evcc instance once it's terminated.
      security:
      - cookieAuth: []
      - bearerAuth: []
      tags:
      - System
      responses:
        '204':
          $ref: '#/components/responses/BlankResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    SuccessResult:
      description: Success
      content:
        application/json:
          schema:
            type: string
            example: OK
    BooleanResult:
      description: Success - Boolean result
      content:
        application/json:
          schema:
            type: boolean
    BlankResponse:
      description: Success - Blank response
    Unauthorized:
      description: Unauthorized - Login and try again
      content:
        text/plain:
          schema:
            type: string
            enum:
            - Unauthorized
  parameters:
    logAreas:
      name: areas
      description: Comma-separated list of log areas
      in: query
      explode: true
      schema:
        $ref: '#/components/schemas/LogAreas'
    logLevel:
      name: level
      description: Log level
      in: query
      required: true
      schema:
        $ref: '#/components/schemas/LogLevel'
    enable:
      name: enable
      description: Charging mode.
      in: path
      required: true
      schema:
        type: string
        enum:
        - 'true'
        - 'false'
        - '1'
        - '0'
  schemas:
    LogArea:
      externalDocs:
        url: https://docs.evcc.io/en/reference/configuration/log#levels
      type: string
    LogLevel:
      externalDocs:
        url: https://docs.evcc.io/en/reference/configuration/log#log
      type: string
      example: DEBUG
      enum:
      - FATAL
      - ERROR
      - WARN
      - INFO
      - DEBUG
      - TRACE
    LogAreas:
      externalDocs:
        url: https://docs.evcc.io/en/reference/configuration/log#levels
      type: array
      example:
      - lp-1
      - site
      - db
      items:
        $ref: '#/components/schemas/LogArea'
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: auth
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Long-lived API key (prefixed `evcc_`, managed via /auth/apikey).

        Grants access to /api/db/* without requiring the X-Admin-Password header.

        '