Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API Documentation Request #43

Open
R0dri opened this issue Jul 29, 2020 · 2 comments
Open

API Documentation Request #43

R0dri opened this issue Jul 29, 2020 · 2 comments

Comments

@R0dri
Copy link

R0dri commented Jul 29, 2020

Digging the code I found access to the API which I found is not documented although easily accesible and usable.

GET @ /operations?
Params:
domain=***** (the domain or url to check)
request=blacklist (the desired test to make)
port=### (Depending on the request type)

And getting a simple JSON response well formatted. I used it with Postman Monitors to check every week if my domain has gone to any blacklist.

I find this API very useful and a handy application overall to host alongside a webmail on a mail server.

@charlesabarnes
Copy link
Owner

I can probably make a simple documentation page with just html

@R0dri
Copy link
Author

R0dri commented Aug 3, 2020

Let me know if I can help with anything, I think just mention on the readme the support for api and what params are needed to what url will suffice.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants