diff --git a/docs/api/supervisor/endpoints.md b/docs/api/supervisor/endpoints.md index e13a1484..ae7b91a5 100644 --- a/docs/api/supervisor/endpoints.md +++ b/docs/api/supervisor/endpoints.md @@ -63,7 +63,35 @@ Get the documentation for an add-on. -Returns the raw container logs from docker. + +Get logs for an add-on via the Systemd journal backend. + +The endpoint accepts the same headers and provides the same functionality as +`/host/logs`. + + + + + +Identical to `/addons//logs` except it continuously returns new log entries. + + + + + +Get logs for an add-on related to a specific boot. + +The `bootid` parameter is interpreted in the same way as in +`/host/logs/boots/` and the endpoint otherwise provides the same +functionality as `/host/logs`. + + + + + +Identical to `/addons//logs/boots/` except it continuously returns +new log entries. + @@ -503,7 +531,35 @@ Return information about the audio plugin. -Returns the raw container logs from docker. + +Get logs for the audio plugin container via the Systemd journal backend. + +The endpoint accepts the same headers and provides the same functionality as +`/host/logs`. + + + + + +Identical to `/audio/logs` except it continuously returns new log entries. + + + + + +Get logs for the audio plugin container related to a specific boot. + +The `bootid` parameter is interpreted in the same way as in +`/host/logs/boots/` and the endpoint otherwise provides the same +functionality as `/host/logs`. + + + + + +Identical to `/audio/logs/boots/` except it continuously returns +new log entries. + @@ -1092,7 +1148,35 @@ Returns information about the Home Assistant core -Returns the raw container logs from docker. + +Get logs for the Home Assistant Core container via the Systemd journal backend. + +The endpoint accepts the same headers and provides the same functionality as +`/host/logs`. + + + + + +Identical to `/core/logs` except it continuously returns new log entries. + + + + + +Get logs for the Home Assistant Core container related to a specific boot. + +The `bootid` parameter is interpreted in the same way as in +`/host/logs/boots/` and the endpoint otherwise provides the same +functionality as `/host/logs`. + + + + + +Identical to `/core/logs/boots/` except it continuously returns +new log entries. + @@ -1282,7 +1366,35 @@ Return information about the DNS plugin. -Returns the raw container logs from docker. + +Get logs for the DNS plugin container via the Systemd journal backend. + +The endpoint accepts the same headers and provides the same functionality as +`/host/logs`. + + + + + +Identical to `/dns/logs` except it continuously returns new log entries. + + + + + +Get logs for the DNS plugin container related to a specific boot. + +The `bootid` parameter is interpreted in the same way as in +`/host/logs/boots/` and the endpoint otherwise provides the same +functionality as `/host/logs`. + + + + + +Identical to `/dns/logs/boots/` except it continuously returns +new log entries. + @@ -2056,7 +2168,35 @@ Returns information about the multicast plugin -Returns the raw container logs from docker. + +Get logs for the multicast plugin via the Systemd journal backend. + +The endpoint accepts the same headers and provides the same functionality as +`/host/logs`. + + + + + +Identical to `/multicast/logs` except it continuously returns new log entries. + + + + + +Get logs for the multicast plugin related to a specific boot. + +The `bootid` parameter is interpreted in the same way as in +`/host/logs/boots/` and the endpoint otherwise provides the same +functionality as `/host/logs`. + + + + + +Identical to `/multicast/logs/boots/` except it continuously returns +new log entries. + @@ -3110,7 +3250,35 @@ Returns information about the supervisor -Returns the raw container logs from docker. +Get logs for the Supervisor container via the Systemd journal backend. If the +Systemd journal gateway fails to provide the logs, raw Docker container logs are +returned as the fallback. + +The endpoint accepts the same headers and provides the same functionality as +`/host/logs`. + + + + + +Identical to `/supervisor/logs` except it continuously returns new log entries. + + + + + +Get logs for the Supervisor container related to a specific boot. + +The `bootid` parameter is interpreted in the same way as in +`/host/logs/boots/` and the endpoint otherwise provides the same +functionality as `/host/logs`. + + + + + +Identical to `/supervisor/logs/boots/` except it continuously returns +new log entries.