diff --git a/docs/api/supervisor/endpoints.md b/docs/api/supervisor/endpoints.md index ae793229..13bedb2a 100644 --- a/docs/api/supervisor/endpoints.md +++ b/docs/api/supervisor/endpoints.md @@ -1478,7 +1478,59 @@ Validate an ingress session, extending it's validity period. -### Misc +### Root + + + +Returns information about available updates + +**Example response:** + +```json +{ + "available_updates": [ + { + "panel_path": "/update-available/core", + "update_type": "core", + "version_latest": "321", + }, + { + "panel_path": "/update-available/os", + "update_type": "os", + "version_latest": "321", + }, + { + "panel_path": "/update-available/supervisor", + "update_type": "supervisor", + "version_latest": "321", + }, + { + "name": "Awesome addon", + "icon": "/addons/awesome_addon/icon", + "panel_path": "/update-available/awesome_addon", + "update_type": "addon", + "version_latest": "321", + } + ] +} +``` + +**Returned data:** + +| key | type | description | +-- | -- | -- +update_type | string | `addon`, `os`, `core` or `supervisor` +name | string | Returns the name (only if the `update_type` is `addon`) +icon | string | Returns the path for the icon if any (only if the `update_type` is `addon`) +version_latest | string | Returns the available version +panel_path | string | Returns path where the UI can be loaded + + + + + +This reloads information about add-on repositories and fetches new version files. + Returns a dict with selected keys from other `/*/info` endpoints. @@ -2278,54 +2330,6 @@ Returns information about the security features ### Supervisor - - -Returns information about available updates - -**Example response:** - -```json -{ - "available_updates": [ - { - "panel_path": "/update-available/core", - "update_type": "core", - "version_latest": "321", - }, - { - "panel_path": "/update-available/os", - "update_type": "os", - "version_latest": "321", - }, - { - "panel_path": "/update-available/supervisor", - "update_type": "supervisor", - "version_latest": "321", - }, - { - "name": "Awesome addon", - "icon": "/addons/awesome_addon/icon", - "panel_path": "/update-available/awesome_addon", - "update_type": "addon", - "version_latest": "321", - } - ] -} -``` - -**Returned data:** - -| key | type | description | --- | -- | -- -update_type | string | `addon`, `os`, `core` or `supervisor` -name | string | Returns the name (only if the `update_type` is `addon`) -icon | string | Returns the path for the icon if any (only if the `update_type` is `addon`) -version_latest | string | Returns the available version -panel_path | string | Returns path where the UI can be loaded - - - - Returns information about the supervisor