path: root/protocol.txt
diff options
authorKaarle Ritvanen <>2014-03-10 22:45:18 +0200
committerKaarle Ritvanen <>2014-03-24 01:18:13 +0200
commit7d9c43916b0600ac4879dfe9793eab807a83ab2b (patch)
treeec54ed64c9a557b6ea4ad88d31138a02d3e0cd04 /protocol.txt
parentcb6c243dc356ef1d46d7ddb96e6ea6ae007c6cca (diff)
rename ACF2 to Alpine Configurator (aconf)
Diffstat (limited to 'protocol.txt')
1 files changed, 9 insertions, 9 deletions
diff --git a/protocol.txt b/protocol.txt
index 85804b4..8853161 100644
--- a/protocol.txt
+++ b/protocol.txt
@@ -1,5 +1,5 @@
-ACF2 HTTP Protocol
+Alpine Configurator HTTP Protocol
Load JavaScript client:
req: GET /
@@ -8,33 +8,33 @@ Log in:
req: POST /login
- body is a JSON object with username and password attributes
resp headers:
- - X-ACF-Auth-Token: authentication token, use in the header of
+ - X-AConf-Auth-Token: authentication token, use in the header of
subsequent requests
- - X-ACF-Save-Required: if set to 1, an explicit request is
+ - X-AConf-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>
+ X-AConf-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)
- - use X-ACF-Transaction-ID in the header of any subsequent
+resp: txn ID (in header as X-AConf-Transaction-ID)
+ - use X-AConf-Transaction-ID in the header of any subsequent
request to process it in the transaction's context
- nested transactions can be started by using it in a subsequent
start transaction request
Commit transaction:
req: PUT /transaction
- X-ACF-Transaction-ID: <txn_id>
+ X-AConf-Transaction-ID: <txn_id>
Abort transaction:
req: DELETE /transaction
- X-ACF-Transaction-ID: <txn_id>
+ X-AConf-Transaction-ID: <txn_id>
Get object:
req: GET /config/<obj_path>