patrowl.local

This is the API documentation for Patrowl Engines usage.

14 endpoints security
📄 Docs 📋 OpenAPI spec 🔬 Try in Swagger UI

SDKs by language (3 total)

PatrowlHearsSDK ✓ Official
pip install PatrowlHearsSDK
PatrowlManagerSDK ✓ Official
pip install PatrowlManagerSDK
PatrowlSDK ✓ Official
pip install PatrowlSDK
curl examples
Index page
curl \
  http://patrowl.local/
Engine info page
curl \
  http://patrowl.local/info
Test page
curl \
  http://patrowl.local/test
Endpoints (14 total)
GET
/
Index page
GET
/info
Engine info page
GET
/test
Test page
GET
/clean
Clean all scans
GET
/status
Status on all scans
GET
/liveness
Liveness page
GET
/readiness
Readiness page
GET
/stopscans
Stop all scans
GET
/reloadconfig
Configuration reloading page
GET
/stop/{scanId}
Stop a scan
GET
/clean/{scanId}
Clean scan
GET
/status/{scanId}
Status of a scan
Language coverage
Python
3
At a glance
Total SDKs3
Languages1
Endpoints14
Categories1
http://patrowl.local