Skip to content

Commit

Permalink
doc: sync endpoints with code
Browse files Browse the repository at this point in the history
  • Loading branch information
vjt committed May 23, 2021
1 parent 9dcf638 commit 3e366a4
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ that these are not available externally.
### Info

```
GET /clammit/info
GET /clammit
```

This method will return JSON giving the current status of Clammit and its connection to ClamAV.
Expand All @@ -224,6 +224,16 @@ This method will return JSON giving the current status of Clammit and its connec
This is the endpoint to submit files for scanning only. Any files to be scanned should be attached as file objects.
Clammit will return an HTTP status code of 200 if the request is clean and 418 if there is a bad attachment.

### Ready

```
GET /clammit/readyz
```

Returns 200 OK unless we are shutting down, waiting for currently running requests to complete.

Clammit does not implement a liveness check, as clammit is available if its TCP socket is open.

### Test

```
Expand Down

0 comments on commit 3e366a4

Please sign in to comment.