External/fredy
1
0
Fork 0
mirror of https://github.com/orangecoding/fredy.git synced 2026-06-16 12:31:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

improving docu

Browse Source
This commit is contained in:
Christian Kellner
2020-07-20 16:23:47 +02:00
parent f1a00cf3bd
commit 269fd1c107
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -152,9 +152,11 @@ Districts that are unwanted can be blacklisted here.
This makes sense for provider that only offer limited filter functions like Kalaydo/Ebay. This makes sense for provider that only offer limited filter functions like Kalaydo/Ebay.
# API # API
While Fredy is running, you can make use of the rest api provided on port `9998` to get information about the current status of Fredy. While Fredy is running, you can make use of the rest api provided on port `9998` to get information about the current status of Fredy.
You can disable the api by setting `infoApi: false` within the config.
#### http://localhost:9998/ #### http://localhost:9998/
Gives you an overview of running search jobs, their included enabled provider, last execution and the number of listings, found by each provider. You can disable the api by setting `infoApi: false` within the config. Gives you an overview of running search jobs, their included enabled provider, last execution and the number of listings, found by each provider.
#### http://localhost:9998/ping #### http://localhost:9998/ping
Should you ever need some health checks, this returns pong ;) Should you ever need some health checks, this returns pong ;)