summaryrefslogtreecommitdiff
path: root/src/automationstatus/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/automationstatus/README.md')
-rw-r--r--src/automationstatus/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/src/automationstatus/README.md b/src/automationstatus/README.md
new file mode 100644
index 0000000..3adf86a
--- /dev/null
+++ b/src/automationstatus/README.md
@@ -0,0 +1,26 @@
+## How to use the automation status API
+
+The automation status API is a REST api for playbooks to report startus as they are running.
+
+URL: /automationstatus/playbook/
+
+## Sending a status updates
+
+POST: /automationstatus/playbook/
+
+Body:
+{
+ "ilo_host_address": "2001:4888:2a10:30c2:101:40a:0:e001",
+ "playbook_name": "test_playbook123",
+ "status": "test_status223"
+}
+
+## Retrieve updates
+
+GET: /automationstatus/playbook/
+
+GET: /automationstatus/playbook/1
+
+
+
+