API Endpoint Role Security Matrix
| Method | Path | ROLE: system | ROLE: admin | ROLE: user | ROLE: api_result_read | ROLE: api_scan |
|---|---|---|---|---|---|---|
| GET | /auth | Y | Y | Y | Y | Y |
| GET | /version | Y | Y | Y | Y | Y |
| GET | /license | Y | Y | Y | Y | Y |
| POST | /license | Y | Y | |||
| PUT | /license | Y | Y | |||
| DELETE | /license | Y | Y | |||
| GET | /alerts/email | Y | Y | |||
| GET | /alerts/email/:id | Y | Y | |||
| POST | /alerts/email | Y | ||||
| PUT | /alerts/email/:id | Y | ||||
| DELETE | /alerts/email/:id | Y | ||||
| POST | /alerts/email/test/:id | Y | ||||
| GET | /alerts/syslog | Y | Y | |||
| GET | /alerts/syslog/:id | Y | Y | |||
| PUT | /alerts/syslog/:id | Y | ||||
| POST | /alerts/syslog | Y | ||||
| DELETE | /alerts/syslog/:id | Y | ||||
| GET | /audit | Y | Y | |||
| DELETE | /audit | Y | ||||
| GET | /config | Y | ||||
| PUT | /config | Y | ||||
| GET | /credentials | Y | Y | Y | Y | |
| GET | /credentials/:id | Y | Y | Y | Y | |
| POST | /credentials/:id | Y | Y | |||
| PUT | /credentials/:id | Y | Y | |||
| DELETE | /credentials | Y | Y | |||
| DELETE | /credentials/:id | Y | Y | |||
| GET | /hosts | Y | Y | Y | Y | |
| GET | /hosts/:id | Y | Y | Y | Y | |
| POST | /hosts | Y | Y | |||
| POST | /hosts/retry | Y | Y | |||
| PUT | /hosts/:id | Y | Y | |||
| DELETE | /hosts | Y | Y | |||
| DELETE | /hosts/:id | Y | Y | |||
| PUT | /hosts/tags | Y | Y | |||
| GET | /jumphosts | Y | Y | Y | Y | |
| GET | /jumphosts/:id | Y | Y | Y | Y | |
| POST | /jumphosts/:id | Y | Y | |||
| PUT | /jumphosts/:id | Y | Y | |||
| DELETE | /jumphosts | Y | Y | |||
| DELETE | /jumphosts/:id | Y | Y | |||
| GET | /reports/host_snapshot | Y | Y | |||
| GET | /reports/scan_performance | Y | Y | |||
| GET | /results/:id | Y | Y | Y | ||
| POST | /results | Y | Y | Y | ||
| POST | /results/timeline | Y | Y | |||
| DELETE | /results/:id | Y | Y | |||
| DELETE | /results | Y | Y | |||
| DELETE | /results/all | Y | Y | |||
| GET | /results/getMaxID | Y | Y | Y | ||
| POST | /results/delete/hostsandflies | Y | Y | |||
| POST | /results/delete/sandflyhosts | Y | Y | |||
| GET | /resultprofiles | Y | Y | |||
| GET | /resultprofiles/:id | Y | Y | |||
| PUT | /resultprofiles/:id | Y | Y | |||
| GET | /resultprofiles/host/:hostid | Y | Y | |||
| DELETE | /resultprofiles/:id | Y | Y | |||
| POST | /resultprofilesDelete | Y | Y | |||
| POST | /resultprofiles | Y | Y | |||
| POST | /resultprofiles/:id/append | Y | Y | |||
| GET | /resultssummary/host/:hostid | Y | Y | Y | ||
| GET | /resultsummary/sandfly/:sandfly | Y | Y | Y | ||
| GET | /sandflies | Y | Y | Y | Y | |
| GET | /sandflies/name/:id | Y | Y | Y | Y | |
| PUT | /sandflies/name/:id/activate | Y | Y | |||
| PUT | /sandflies/name/:id/deactivate | Y | Y | |||
| PUT | /sandflies/activate | Y | Y | |||
| PUT | /sandflies/deactivate | Y | Y | |||
| POST | /sandflies | Y | Y | |||
| PUT | /sandflies | Y | Y | |||
| PUT | /sandflies/response/:id | Y | Y | |||
| DELETE | /sandflies/name/:id | Y | Y | |||
| DELETE | /sandflies/name | Y | Y | |||
| GET | /sandflies/backup | Y | Y | |||
| POST | /sandflies/reload_all | Y | Y | |||
| GET | /savedviews | Y | Y | |||
| GET | /savedviews/:namespace | Y | Y | |||
| DELETE | /savedviews/:namespace/:name | Y | Y | |||
| POST | /savedviews | Y | Y | |||
| POST | /scan | Y | Y | Y | ||
| POST | /scan/adhoc | Y | Y | Y | ||
| GET | /schedule | Y | Y | |||
| GET | /schedule/:id | Y | Y | |||
| POST | /schedule | Y | Y | |||
| PUT | /schedule/:id | Y | Y | |||
| PUT | /schedule/pause/:id | Y | Y | |||
| PUT | /schedule/unpause/:id | Y | Y | |||
| PUT | /schedule/pause/ | Y | Y | |||
| PUT | /schedule/unpause/ | Y | Y | |||
| POST | /schedule/run/:id | Y | Y | |||
| DELETE | /schedule | Y | Y | |||
| DELETE | /schedule/:id | Y | Y | |||
| POST | /sharedurl | Y | Y | |||
| GET | /sshhunter/summary | Y | Y | Y | ||
| GET | /sshhunter/minisummary | Y | Y | Y | ||
| GET | /sshhunter/key/:id | Y | Y | Y | ||
| PUT | /sshhunter/key/:id/tags | Y | Y | |||
| PUT | /sshhunter/key/tags | Y | Y | |||
| GET | /sshhunter/users | Y | Y | Y | ||
| GET | /sshhunter/users/:username | Y | Y | Y | ||
| GET | /sshhunter/hosts | Y | Y | Y | ||
| GET | /sshhunter/hosts/:hostid | Y | Y | Y | ||
| GET | /sshhunter/graph/:type/:id | Y | Y | Y | ||
| POST | /sshhunter/hosttags | Y | Y | |||
| POST | /sshhunter/keyhosttags | Y | Y | |||
| POST | /sshhunter/hostkeytags | Y | Y | |||
| GET | /sshhunter/zones | Y | Y | |||
| GET | /sshhunter/zones/:id | Y | Y | |||
| POST | /sshhunter/zones | Y | Y | |||
| PUT | /sshhunter/zones/:id | Y | Y | |||
| DELETE | /sshhunter/zones/:id | Y | Y | |||
| GET | /dashboard | Y | Y | |||
| GET | /status | Y | Y | |||
| GET | /status/nodes | Y | Y | |||
| POST | /status/tags | Y | Y | |||
| POST | /system/results | Y | ||||
| POST | /system/hosts/:id | Y | ||||
| PUT | /system/hosts/:id | Y | ||||
| POST | /system/node | Y | ||||
| GET | /tags/hosts | Y | Y | |||
| GET | /tags/sandflies | Y | Y | |||
| GET | /tags/sshkeys | Y | Y | |||
| GET | /tasks/queues/names | Y | Y | |||
| DELETE | /tasks/all | Y | Y | |||
| GET | /threatfeeds | Y | Y | |||
| GET | /threatfeeds/:id | Y | Y | |||
| POST | /threatfeeds | Y | ||||
| PUT | /threatfeeds/:id | Y | ||||
| DELETE | /threatfeeds/:id | Y | ||||
| GET | /users | Y | ||||
| GET | /users/:id | (only self) | Y | (only self) | (only self) | (only self) |
| POST | /users/:id | Y | ||||
| PUT | /users/:id | Y | ||||
| PUT | /users/password/:id | (only self) | Y | (only self) | (only self) | (only self) |
| DELETE | /users/:id | Y | ||||
| GET | /whitelistrules | Y | Y | |||
| GET | /whitelistrules/host/:hostid | Y | Y | |||
| GET | /whitelistrules/sandfly/:sandfly | Y | Y | |||
| GET | /whitelistrules/:id | Y | Y | |||
| POST | /whitelistrules | Y | Y | |||
| PUT | /whitelistrules/:id | Y | Y | |||
| DELETE | /whitelistrules/:id | Y | Y | |||
| POST | /whitelistrulesDelete | Y | Y | |||
| PUT | /whitelistrules/activate/:id | Y | Y | |||
| PUT | /whitelistrules/deactivate/:id | Y | Y | |||
| PUT | /whitelistrules/activate/ | Y | Y | |||
| PUT | /whitelistrules/deactivate/ | Y | Y | |||
| POST | /errors | Y | ||||
| GET | /errors | Y | Y | Y | Y | |
| DELETE | /errors | Y | Y |
Updated 4 months ago