Integrity check (#1316)

* Add integrity check documentation

* add untested

* Add examples

* Update docs/api/supervisor/endpoints.md

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>

* Update docs/api/supervisor/endpoints.md

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>
This commit is contained in:
Pascal Vizeli 2022-05-02 13:37:12 +02:00 committed by GitHub
parent 4703ac058d
commit 20cf80ebe7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -2345,6 +2345,38 @@ Returns information about the security features
</ApiEndpoint>
<ApiEndpoint path="/security/integrity" method="post">
Run a full platform integrity check.
**Returned data:**
| key | type | description |
| ----| ---- | ----------- |
| supervisor | str | `pass`, `error`, `failed`, `untested` |
| core | str | `pass`, `error`, `failed`, `untested` |
| plugins | dict | A dictionary with key per plugin as `pass`, `error`, `failed`, `untested` |
| addons | dict | A dictionary with key per addon as `pass`, `error`, `failed`, `untested` |
**Example response:**
```json
{
"supervisor": "pass",
"core": "pass",
"plugins": {
"audio": "pass",
"cli": "pass"
},
"addons": {
"core_ssh": "untested",
"xj3493_test": "pass"
}
}
```
</ApiEndpoint>
### Supervisor
<ApiEndpoint path="/supervisor/info" method="get">