path: root/protocol.txt
diff options
authorKaarle Ritvanen <>2013-09-16 16:05:32 +0300
committerKaarle Ritvanen <>2013-09-16 16:05:32 +0300
commit5467f2ddadeaaf74dfb2109d53c4d5be9f275f20 (patch)
treef649f50edfefb146f097fd8da39a13dd4e261b84 /protocol.txt
parentdb136cebdda6f853fdc08a3b4beaeef310a11a22 (diff)
integration with 'lbu commit'
client must specifically request saving files if server's root file system is tmpfs web client does this automatically on commit
Diffstat (limited to 'protocol.txt')
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)