mirrors/zevenet-zproxy
2
0
Fork 0
mirror of https://github.com/zevenet/zproxy.git synced 2025-10-26 11:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Reformat CTL API docs

Browse Source 
Signed-off-by: Nicolás A. Ortega Froysa <nicolas.ortega@zevenet.com>
This commit is contained in:
Nicolás A. Ortega Froysa 2023-05-09 08:31:20 +02:00
parent c712a66fc3
commit 02834b10b8
1 changed files with 22 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
doc/ctl-api.md
View File

@ -205,7 +205,14 @@ PATCH '{"status":"active"}' /listener/<listener_id>/service/<service_id>/backend
- Add backend in runtime
```
PUT '{"id":"<backend_id>","address":"<address>","https":<bool>, "port": <port>, "weight": <weight>}' /listener/<listener_id>/service/<service_id>/backends
PUT
'{
"id": "<backend_id>",
"address": "<address>",
"https": <bool>,
"port": <port>,
"weight": <weight>
}' /listener/<listener_id>/service/<service_id>/backends
```
### Session
@ -213,7 +220,12 @@ PUT '{"id":"<backend_id>","address":"<address>","https":<bool>, "port": <port>,
- Create new session
```
PUT '{"backend-id":"<backend_id>","id":"<session_id>","last-seen":<last_seen>}' /listener/<listener_id>/service/<service_id>/sessions
PUT
'{
"backend-id": "<backend_id>",
"id": "<session_id>",
"last-seen": <last_seen>
}' /listener/<listener_id>/service/<service_id>/sessions
```
- Flush service sessions
@ -237,7 +249,11 @@ DELETE '{"backend-id":"<backend_id>"}' /listener/<listener_id>/service/<service_
- Modify session
```
PATCH '{"backend-id":"<backend_id>","last-seen":<last_seen>}' /listener/<listener_id>/service/<service_id>/session/<session_id>
PATCH
'{
"backend-id": "<backend_id>",
"last-seen": <last_seen>
}' /listener/<listener_id>/service/<service_id>/session/<session_id>
```
- Synchronize sessions from JSON array
@ -266,9 +282,9 @@ PATCH
"name": "<service_name>",
"sessions": [
{
"id":"<sess_id>",
"backend-id":"<backend_id>",
"last-seen":<last_seen>
"id": "<sess_id>",
"backend-id": "<backend_id>",
"last-seen": <last_seen>
},
...
]