summaryrefslogtreecommitdiffstats
path: root/protocol.txt
diff options
context:
space:
mode:
Diffstat (limited to 'protocol.txt')
-rw-r--r--protocol.txt10
1 files changed, 8 insertions, 2 deletions
diff --git a/protocol.txt b/protocol.txt
index bf00116..d9f861a 100644
--- a/protocol.txt
+++ b/protocol.txt
@@ -7,13 +7,19 @@ req: GET /
Log in:
req: POST /login
- body is a JSON object with username and password attributes
-resp: authentication token (in header as X-ACF-Auth-Token)
- - use X-ACF-Auth-Token in the header of subsequent requests
+resp headers:
+ - X-ACF-Auth-Token: authentication token, use in the header of
+ subsequent requests
+ - X-ACF-Save-Required: if set to 1, an explicit request is
+ required to save the changed files persistently
Log out:
req: DELETE /login
X-ACF-Auth-Token: <token>
+Save configuration files persistently (lbu commit):
+req: POST /save
+
Start transaction:
req: POST /transaction
resp: txn ID (in header as X-ACF-Transaction-ID)