From a25ca2becbb59b43f8cd072737f2f9b5fe5a1b9c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=2E=20Mert=20Y=C4=B1ld=C4=B1ran?= Date: Tue, 9 Nov 2021 14:36:50 +0300 Subject: [PATCH] Add the list of endpoints provided by the API server --- Introduction-to-Mizu.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/Introduction-to-Mizu.md b/Introduction-to-Mizu.md index cadfaaf..d487aef 100644 --- a/Introduction-to-Mizu.md +++ b/Introduction-to-Mizu.md @@ -60,4 +60,25 @@ If the tapper is a highway, the API server is a freeway. It's the road all the o The API server pod communicates with the tappers through a series of WebSocket pipelines and eventually streams the dissected traffic into the web UI. It's essentially a web application, such that it provides a REST API, a server -for the React app (web UI) and lets you do a bunch of other things that can be done after the traffic analysis step. \ No newline at end of file +for the React app (web UI) and lets you do a bunch of other things that can be done after the traffic analysis step. + +#### Entries + +- `GET /ws` is the WebSocket endpoint for streaming the results to the client. +- `GET /entries/:entryId` is the endpoint to fetch an individual entry. + +#### Metadata + +- `GET /metadata/version` returns the Mizu version. + +#### Status + +- `GET /status/health` health check endpoint. +- `POST /status/tapperPods` the endpoint for updating the properties of tapper pods. +- `GET /status/tappersCount` returns the number of tapper pods that are deployed. +- `GET /status/tap` returns the tapping status. +- `GET /status/auth` returns the UP9 authentication status. +- `GET /status/analyze` returns the stats of UP9 traffic upload(`--analysis` option). +- `GET /status/general` returns the general stats. +- `GET /status/recentTLSLinks` returns the recent TLS links. +- `GET /status/resolving` returns the current solving information. \ No newline at end of file