ESPHome Log Collector (1.0.0)

Download OpenAPI specification:

Read-only HTTP API of the web UI. There is no authentication: bind to localhost or put an authenticated reverse proxy in front. The HTML pages, POST /export (CSRF-protected) and GET /exports/{name} downloads belong to the browser UI and are not part of this contract.

api

Search stored events (newest first, paginated)

query Parameters
Device (string) or Device (null) (Device)

Only events of this device.

Start (string) or Start (null) (Start)

Inclusive start (ISO-8601, UTC if no zone).

End (string) or End (null) (End)

Exclusive end (ISO-8601, UTC if no zone).

Level (string) or Level (null) (Level)
Enum: "VERY_VERBOSE" "DEBUG" "CONFIG" "INFO" "WARNING" "ERROR" "CRITICAL"

Minimum log level.

Type (string) or Type (null) (Type)
Enum: "log" "session_start" "session_end" "connected" "disconnected" "retry_scheduled" "gap" "collector_error"

Only this event type.

Q (string) or Q (null) (Q)

Case-insensitive substring match on the raw line (LIKE wildcards are literal).

page
integer (Page)
Default: 1

1-based page number (values below 1 are treated as 1).

Page Size (integer) or Page Size (null) (Page Size)

Events per page, clamped to 1..500; default is web.page_size.

Responses

Response samples

Content type
application/json
{
  • "events": [
    ],
  • "has_next": true
}

Collector status of every known device

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Live tail as Server-Sent Events

query Parameters
Device (string) or Device (null) (Device)

Only events of this device.

Start (string) or Start (null) (Start)

Inclusive start (ISO-8601, UTC if no zone).

End (string) or End (null) (End)

Exclusive end (ISO-8601, UTC if no zone).

Level (string) or Level (null) (Level)
Enum: "VERY_VERBOSE" "DEBUG" "CONFIG" "INFO" "WARNING" "ERROR" "CRITICAL"

Minimum log level.

Type (string) or Type (null) (Type)
Enum: "log" "session_start" "session_end" "connected" "disconnected" "retry_scheduled" "gap" "collector_error"

Only this event type.

Q (string) or Q (null) (Q)

Case-insensitive substring match on the raw line (LIKE wildcards are literal).

after
integer (After)
Default: 0

Only stream events with an id greater than this (non-negative).

header Parameters
Last-Event-Id (string) or Last-Event-Id (null) (Last-Event-Id)

Set by EventSource on reconnect; overrides after.

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}