{"note":"OpenAPI conversion -- returning structured metadata","name":"patrowl-local","description":"Swagger API-REST for Patrowl Engines","version":"1.0.0","base_url":"http://localhost:5001/engines/nmap/","endpoints":14,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Swagger API-REST for Patrowl Engines\n@base http://localhost:5001/engines/nmap/\n@version 1.0.0\n@endpoints 14\n@toc root(1), liveness(1), readiness(1), test(1), reloadconfig(1), info(1), clean(2), status(2), stopscans(1), stop(1), getfindings(1), startscan(1)\n\n@group root\n@endpoint GET /\n@desc Index page\n@returns(200) {status: str, page: str} # successful operation\n\n@endgroup\n\n@group liveness\n@endpoint GET /liveness\n@desc Liveness page\n@returns(200) successful operation\n\n@endgroup\n\n@group readiness\n@endpoint GET /readiness\n@desc Readiness page\n@returns(200) successful operation\n\n@endgroup\n\n@group test\n@endpoint GET /test\n@desc Test page\n@returns(200) successful operation\n\n@endgroup\n\n@group reloadconfig\n@endpoint GET /reloadconfig\n@desc Configuration reloading page\n@returns(200) {status: str, page: str} # successful operation\n\n@endgroup\n\n@group info\n@endpoint GET /info\n@desc Engine info page\n@returns(200) {status: str, page: str} # successful operation\n\n@endgroup\n\n@group clean\n@endpoint GET /clean\n@desc Clean all scans\n@returns(200) {status: str, page: str} # successful operation\n\n@endpoint GET /clean/{scanId}\n@desc Clean scan\n@required {scanId: int # Numeric ID of the scan to clean}\n@returns(200) {status: str, page: str} # successful operation\n\n@endgroup\n\n@group status\n@endpoint GET /status\n@desc Status on all scans\n@returns(200) {status: str, page: str} # successful operation\n\n@endpoint GET /status/{scanId}\n@desc Status of a scan\n@required {scanId: int # Numeric ID of the scan to get status}\n@returns(200) {status: str, page: str} # successful operation\n\n@endgroup\n\n@group stopscans\n@endpoint GET /stopscans\n@desc Stop all scans\n@returns(200) {status: str, page: str} # successful operation\n\n@endgroup\n\n@group stop\n@endpoint GET /stop/{scanId}\n@desc Stop a scan\n@required {scanId: int # Numeric ID of the scan to stop}\n@returns(200) {status: str, page: str} # successful operation\n\n@endgroup\n\n@group getfindings\n@endpoint GET /getfindings/{scanId}\n@desc Get findings on finished scans\n@required {scanId: int # Numeric ID of the scan to get findings}\n@returns(200) successful operation\n\n@endgroup\n\n@group startscan\n@endpoint POST /startscan\n@desc Start a new scan\n@optional {scan_id: int, options: map, assets: [map{id: str, value: str, criticity: str, datatype: str}]}\n@returns(200) {status: str, page: str} # successful operation\n\n@endgroup\n\n@end\n"}