adelorenzo/stable
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Matthias 2019-11-11 20:25:44 +01:00
parent 75d5ff69ef
commit 800997437a
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/rest-api.md
View File

@ -22,14 +22,14 @@ Sample configuration:
!!! Danger "Password selection" !!! Danger "Password selection"
Please make sure to select a very strong, unique password to protect your bot from unauthorized access. Please make sure to select a very strong, unique password to protect your bot from unauthorized access.
You can then access the API by going to `http://127.0.0.1:8080/api/v1/ping` to check if the API is running correctly. You can then access the API by going to `http://127.0.0.1:8080/api/v1/ping` in a browser to check if the API is running correctly.
This should return the response: This should return the response:
``` output ``` output
{"status":"pong"} {"status":"pong"}
``` ```
All other endpoints will require authentication, so are not available through a webrowser. All other endpoints return sensitive info and require authentication, so are not available through a webrowser.
To generate a secure password, either use a password manager, or use the below code snipped. To generate a secure password, either use a password manager, or use the below code snipped.