From 6402b0c221885dd255cd77efce116577f77d042e Mon Sep 17 00:00:00 2001
From: Girish Ramakrishnan <girish@cloudron.io>
Date: Wed, 12 Apr 2017 18:38:33 -0700
Subject: [PATCH] doc: update check api

---
 docs/references/api.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/docs/references/api.md b/docs/references/api.md
index 55f955096..2c45622c8 100644
--- a/docs/references/api.md
+++ b/docs/references/api.md
@@ -694,6 +694,23 @@ Curl example to activate the cloudron:
 curl -X POST -H "Content-Type: application/json" -d '{"username": "girish", "password":"MySecret123#", "email": "girish@cloudron.io" }' https://my.cloudron.info/api/v1/cloudron/activate
 ```
 
+### Check for updates
+
+POST `/api/v1/check_for_updates` <scope>admin</scope>
+
+Checks for any available updates for the Cloudron and the installed apps.
+
+Response (200):
+```
+{
+    box: null|<object>,            // object containing information about update
+    apps: {                        // update info (if any) for each app
+        <appid>: <object>,
+        ...
+    }
+}
+```
+
 ### Update the Cloudron
 
 POST `/api/v1/cloudron/update` <scope>admin</scope>