HomeDocumentationAPI Reference
Log In
Documentation

API Endpoint Role Security Matrix

MethodPathsystemadminpower_userresponderuserapi_result_readapi_scan
GET/authYYYYYYY
GET/versionYYYYYYY
GET/licenseYYYYYYY
POST/licenseYYY
PUT/licenseYYY
DELETE/licenseYYY
POST/license/refreshYY
GET/alerts/emailYYYY
GET/alerts/email/:idYYYY
POST/alerts/emailYY
PUT/alerts/email/:idYY
DELETE/alerts/email/:idYY
POST/alerts/email/test/:idYY
GET/alerts/syslogYYYY
GET/alerts/syslog/:idYYYY
PUT/alerts/syslog/:idYY
POST/alerts/syslogYY
DELETE/alerts/syslog/:idYY
GET/auditYY
DELETE/auditY
GET/configYY
PUT/configYY
GET/credentialsYYYYYY
GET/credentials/:idYYYYYY
POST/credentials/:idYYYY
PUT/credentials/:idYYYY
DELETE/credentialsYYYY
DELETE/credentials/:idYYYY
GET/hostsYYYYYY
GET/hosts/:idYYYYYY
POST/hostsYYYY
POST/hosts/retryYYYY
PUT/hosts/:idYYYY
DELETE/hostsYYYY
DELETE/hosts/:idYYYY
PUT/hosts/tagsYYYY
GET/hosts/:id/info/kernelmodulesYYYYY
GET/hosts/:id/info/lastlogYYYYY
GET/hosts/:id/info/listenersYYYYY
GET/hosts/:id/info/loggedinusersYYYYY
GET/hosts/:id/info/processesYYYYY
GET/hosts/:id/info/scheduledtasksYYYYY
GET/hosts/:id/info/servicesYYYYY
GET/hosts/:id/info/usersYYYYY
GET/hostsrollup/:idYYYYY
GET/jumphostsYYYYYY
GET/jumphosts/:idYYYYYY
POST/jumphosts/:idYYYY
PUT/jumphosts/:idYYYY
DELETE/jumphostsYYYY
DELETE/jumphosts/:idYYYY
GET/llmanalysisYYYY
GET/llmanalysis/:idYYYY
POST/llmanalysisYYYY
PUT/llmanalysis/:id/chatYYYY
GET/llmanalysis/:id/waitYYYY
DELETE/llmanalysis/:idYYYY
POST/llmanalysis/bulkdeleteYYYY
GET/notificationsYYYY
GET/notifications/:idYY
POST/notificationsYY
PUT/notifications/:idYY
DELETE/notifications/:idYY
PUT/notifications/pause/:idYY
PUT/notifications/unpause/:idYY
PUT/notifications/pause/YY
PUT/notifications/unpause/YY
POST/notifications/test/:idYY
GET/reports/host_snapshotYYYY
GET/reports/scan_performanceYYYY
GET/results/:idYYYYY
POST/resultsYYYYY
POST/results/timelineYYYY
DELETE/results/:idYYYY
DELETE/resultsYYYY
DELETE/results/allYYYY
GET/results/getMaxIDYYYYY
POST/results/delete/hostsandfliesYYYY
POST/results/delete/sandflyhostsYYYY
GET/resultdetail/:idYYYYY
GET/resultprofilesYYYY
GET/resultprofiles/:idYYYY
GET/resultprofiles/:id/sandfly/:sandflyYYYY
DELETE/resultprofiles/:id/sandfly/:sandflyYYYY
DELETE/resultprofiles/:id/sandfly/:sandfly/:hashYYYY
POST/resultprofiles/:id/sandfly/:sandfly/deleteresultsYYYY
PUT/resultprofiles/:idYYYY
GET/resultprofiles/host/:hostidYYYY
DELETE/resultprofiles/:idYYYY
POST/resultprofilesDeleteYYYY
POST/resultprofilesYYYY
POST/resultprofiles/:id/appendYYYY
POST/resultprofiles/:id/deletesandfliesYYYY
POST/resultprofiles/:id/autoappendYYYY
POST/resultprofiles/exportYYYY
POST/resultprofiles/importYYYY
POST/resultprofiles/autodriftYYYY
GET/resultprofiles/autodrifttemplatesYYYY
GET/resultprofileresult/:idYYYY
PUT/resultprofiles/pause/:idYYYY
PUT/resultprofiles/unpause/:idYYYY
PUT/resultprofiles/pause/YYYY
PUT/resultprofiles/unpause/YYYY
DELETE/resultprofiles/autodrift/:id/gatherYYYY
DELETE/resultprofiles/autodrift/:id/scheduleYYYY
PUT/resultprofiles/autodrift/:id/restartgatherYYYY
PUT/resultprofiles/autodrift/:id/enforceYYYY
PUT/resultprofiles/autodrift/:idYYYY
GET/resultssummary/host/:hostidYYYYY
GET/resultsummary/sandfly/:sandflyYYYYY
POST/responseaction/result/:id/:actionY
POST/responseaction/sshpubkey/:keyid/:actionY
POST/responseaction/sshpubkey/:keyid/:action/host/:host_sequence_idY
POST/responseaction/sshpubkey/:keyid/:action/host/:host_sequence_id/user/:usernameY
GET/responseaction/logYYYY
GET/responseaction/log/:idYYYY
DELETE/responseaction/log/:id/dataY
GET/responeaction/data/:hashY
GET/sandfliesYYYYYY
GET/sandflies/name/:idYYYYYY
PUT/sandflies/name/:id/activateYYYY
PUT/sandflies/name/:id/deactivateYYYY
PUT/sandflies/activateYYYY
PUT/sandflies/deactivateYYYY
POST/sandfliesYYYY
PUT/sandfliesYYYY
PUT/sandflies/response/:idYYYY
DELETE/sandflies/name/:idYYYY
DELETE/sandflies/nameYYYY
GET/sandflies/backupYYYY
POST/sandflies/reload_allYYYY
GET/savedviewsYYYY
GET/savedviews/:namespaceYYYY
DELETE/savedviews/:namespace/:nameYYYY
POST/savedviewsYYYY
POST/scanYYYYY
POST/scan/adhocYYYYY
GET/scheduleYYYY
GET/schedule/:idYYYY
POST/scheduleYYYY
PUT/schedule/:idYYYY
PUT/schedule/:id/abortYYYY
PUT/schedule/pause/:idYYYY
PUT/schedule/unpause/:idYYYY
PUT/schedule/pause/YYYY
PUT/schedule/unpause/YYYY
POST/schedule/run/:idYYYY
DELETE/scheduleYYYY
DELETE/schedule/:idYYYY
POST/sharedurlYYYY
GET/sshhunter/summaryYYYYY
GET/sshhunter/minisummaryYYYYY
GET/sshhunter/key/:idYYYYY
PUT/sshhunter/key/:id/tagsYYYY
PUT/sshhunter/key/tagsYYYY
GET/sshhunter/usersYYYYY
GET/sshhunter/users/:usernameYYYYY
GET/sshhunter/hostsYYYYY
GET/sshhunter/hosts/:hostidYYYYY
GET/sshhunter/graph/:type/:idYYYYY
POST/sshhunter/hosttagsYYYY
POST/sshhunter/keyhosttagsYYYY
POST/sshhunter/hostkeytagsYYYY
GET/sshhunter/zonesYYYY
GET/sshhunter/zones/:idYYYY
POST/sshhunter/zonesYYYY
PUT/sshhunter/zones/:idYYYY
DELETE/sshhunter/zones/:idYYYY
GET/dashboardYYYY
GET/statusYYYY
GET/status/nodesYYYY
POST/status/tagsYYYY
POST/system/resultsY
POST/system/hosts/:idY
PUT/system/hosts/:idY
POST/system/nodeY
GET/tags/hostsYYYY
GET/tags/sandfliesYYYY
GET/tags/sshkeysYYYY
GET/tasks/queues/namesYYYY
DELETE/tasks/allYYYY
GET/threatfeedsYYYY
GET/threatfeeds/:idYYYY
POST/threatfeedsYY
PUT/threatfeeds/:idYY
DELETE/threatfeeds/:idYY
GET/usersY
GET/users/:id(only self)Y(only self)(only self)(only self)(only self)(only self)
POST/users/:idY
PUT/users/:idY
PUT/users/password/:id(only self)Y(only self)(only self)(only self)(only self)(only self)
DELETE/users/:idY
GET/whitelistrulesYYYY
GET/whitelistrules/host/:hostidYYYY
GET/whitelistrules/sandfly/:sandflyYYYY
GET/whitelistrules/:idYYYY
POST/whitelistrulesYYYY
PUT/whitelistrules/:idYYYY
DELETE/whitelistrules/:idYYYY
POST/whitelistrulesDeleteYYYY
PUT/whitelistrules/activate/:idYYYY
PUT/whitelistrules/deactivate/:idYYYY
PUT/whitelistrules/activate/YYYY
PUT/whitelistrules/deactivate/YYYY
POST/errorsY
GET/errorsYYYYYY
DELETE/errorsYYYY