aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index 33703dd..cd45156 100644
--- a/README.md
+++ b/README.md
@@ -82,6 +82,11 @@ Example of that custom config change subscription can be found in `example` dire
### REST API
Netconf server provides REST interface, with enpoints:
- *GET* `/healthcheck` returns 200 "UP" if server is up and running
+- *POST* `/readiness` return 200 "Ready" if server is ready, if not, returns 503 "Not Ready"
+- *POST* `/change_config/<path:module_name>` changes configuration ad returns 202 "Accepted"
+- *GET* `/change_history` returns 200 and change history as json
+- *GET* `/get_config/<path:module_name>` returns 200 and current configuration
+
### logging
Netconf server print all logs on to the console.