Add endpoint to retrieve the version of the appliance

on-prem · Jul 6, 2015 · 4ec5e38 · 4ec5e38
1 parent 00bda7d
commit 4ec5e38
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.1.2 (2015-07-06)
+
+  * Add endpoint to retrieve the version of the appliance
+
 ## 1.1.1 (2015-07-06)
 
   * Add endpoint to retrieve compressed logs

diff --git a/api/v1/core/allowed.l b/api/v1/core/allowed.l
@@ -5,7 +5,7 @@
 # Copyright (c) 2015 Alexander Williams, Unscramble <license@unscramble.jp>
 
 (allowed ("api/v1/admin")
-  newtoken token setup license settings update logs )
+  newtoken token setup license settings update logs version )
 
 (allow "docs/" T)
 

diff --git a/docs/API.md b/docs/API.md
@@ -13,6 +13,8 @@ All API calls are prefixed with `/api/v1/admin`
   9. Update the network and application settings
   10. View the network and application settings
   11. Retrieve compressed log files
+  12. Retrieve the version of the virtual appliance
+
 
 ### 1. Authentication
 
@@ -284,4 +286,24 @@ Content-Type: application/octet-stream
 Filename: logs.tar.gz
 ```
 
+### 12. Retrieve the version of the virtual appliance
+
+**Endpoint**
+
+```
+GET /api/v1/admin/version
+```
+
+**Example**
+
+```
+curl -X GET https://enterprise.vm:8443/api/v1/admin/version?token=yourtoken
+
+HTTP/1.1 200 OK
+Content-Type: application/json
+{
+    "version": "1.0.0"
+}
+```
+
 **Powered by [Jidoteki](https://jidoteki.com) - [Copyright notices](NOTICE)**
diff --git a/module.l b/module.l
@@ -1,6 +1,6 @@
 [de MODULE_INFO
   ("name"       "jidoteki-admin-api")
-  ("version"    "1.1.1")
+  ("version"    "1.1.2")
   ("summary"    "Jidoteki Admin API")
   ("source"     "https://jidoteki.com")
   ("author"     "Alexander Williams")