doc: disks api

2017-04-07 12:45:33 -07:00
parent 558acf27a3
commit 4d737d535a
2 changed files with 14 additions and 1 deletions
--- a/docs/references/api.md
+++ b/docs/references/api.md
@@ -794,6 +794,20 @@ Response (200):
 }
 ```

+### Get disks
+
+GET `/api/v1/cloudron/disks` <scope>admin</scope>
+
+Gets information on the disks being used on the Cloudron server.
+
+```
+Response (200):
+{
+    boxDataDisk: <string>,            // Disk used for storing box data
+    platformDataDisk: <string>,       // Disk used for addon databases and email
+    appsDataDisk: <string>            // Disk used for apps' local storage
+}
+```

 ## Eventlog