You've already forked caddy-opnsense-blocker
Improve requests log filters and sorting
This commit is contained in:
32
docs/api.md
32
docs/api.md
@@ -72,18 +72,44 @@ Query parameters:
|
||||
- optional
|
||||
- default: `1`
|
||||
- one-based page number
|
||||
- `source`
|
||||
- optional
|
||||
- exact source name match, case-insensitive
|
||||
- `method`
|
||||
- optional
|
||||
- exact HTTP method match, case-insensitive
|
||||
- use `OTHER` to match methods outside the common set (`GET`, `POST`, `HEAD`, `PUT`, `DELETE`, `PATCH`, `OPTIONS`)
|
||||
- `status`
|
||||
- optional
|
||||
- accepts a full HTTP status code such as `404`
|
||||
- also accepts a class selector such as `4xx` or `5xx`
|
||||
- `state`
|
||||
- optional
|
||||
- one of `observed`, `review`, `blocked`, `allowed`
|
||||
- `bot_filter`
|
||||
- optional
|
||||
- default: `all`
|
||||
- accepted values: `all`, `known`, `possible`, `any`, `non-bot`
|
||||
- `sort_by`
|
||||
- optional
|
||||
- default: `time`
|
||||
- accepted values: `time`, `ip`, `method`, `source`, `request`, `status`, `state`, `reason`
|
||||
- `sort_dir`
|
||||
- optional
|
||||
- default: `desc`
|
||||
- accepted values: `asc`, `desc`
|
||||
- `show_known_bots`
|
||||
- optional
|
||||
- default: `true`
|
||||
- when `false`, verified bots are hidden from the log
|
||||
- compatibility filter that hides verified bots when `false`
|
||||
- `show_allowed`
|
||||
- optional
|
||||
- default: `true`
|
||||
- when `false`, rows whose current IP state is `allowed` are hidden
|
||||
- compatibility filter that hides rows whose current IP state is `allowed` when `false`
|
||||
- `review_only`
|
||||
- optional
|
||||
- default: `false`
|
||||
- when `true`, only requests whose current IP state is `review` are returned
|
||||
- compatibility filter that maps to `state=review` when `state` is not already set
|
||||
|
||||
Main response fields:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user