[GH-ISSUE #43] API Documentation Request #21

New issue

Open

opened 2026-02-25 21:30:50 +03:00 by kerem · 2 comments

kerem commented

2026-02-25 21:30:50 +03:00

Owner

Originally created by @doza62 on GitHub (Jul 29, 2020).
Original GitHub issue: https://github.com/charlesabarnes/SPFtoolbox/issues/43

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.

Originally created by @doza62 on GitHub (Jul 29, 2020). Original GitHub issue: https://github.com/charlesabarnes/SPFtoolbox/issues/43 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.

kerem added the

Good First Issue

label

2026-02-25 21:30:50 +03:00

kerem commented

2026-02-25 21:30:50 +03:00

Author

Owner

@charlesabarnes commented on GitHub (Jul 29, 2020):

I can probably make a simple documentation page with just html

@charlesabarnes commented on GitHub (Jul 29, 2020): I can probably make a simple documentation page with just html

kerem commented

2026-02-25 21:30:50 +03:00

Author

Owner

@doza62 commented on GitHub (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.

@doza62 commented on GitHub (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.

kerem referenced this issue

2026-02-25 21:30:56 +03:00

[PR #29] [MERGED] F/refactor #45