github/kubeshark
1
0
Fork 0
mirror of https://github.com/kubeshark/kubeshark.git synced 2025-08-20 09:26:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add the list of endpoints provided by the API server

M. Mert Yıldıran 2021-11-09 14:36:50 +03:00
parent 6a8f7e5eb9
commit a25ca2becb
1 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
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.
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.