From 20cf80ebe7941fa6d533646729f50ef2a7274b98 Mon Sep 17 00:00:00 2001
From: Pascal Vizeli <pvizeli@syshack.ch>
Date: Mon, 2 May 2022 13:37:12 +0200
Subject: [PATCH] Integrity check (#1316)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* 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>
---
 docs/api/supervisor/endpoints.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/docs/api/supervisor/endpoints.md b/docs/api/supervisor/endpoints.md
index 714cde97..c4f05628 100644
--- a/docs/api/supervisor/endpoints.md
+++ b/docs/api/supervisor/endpoints.md
@@ -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">