Jump to Content
Home
Documentation
API Reference
v5.0.0
v5.1.0
v5.1.1
v5.2.0
v5.3.0
v5.3.1
v5.4.0
v5.4.1
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v5.4.1
API Reference
Delete user
Search
JUMP TO
API - Getting Started
Getting Started - Sandfly API
Sandfly API
Notifications
Get all email alerts
get
Add email entry
post
Test email entry
post
Delete email entry
delete
Get email entry
get
Update email entry
put
Get all syslog entries
get
Add syslog entry
post
Delete syslog entry
delete
Get syslog entry
get
Update syslog entry
put
Get notifications
get
Create notification
post
Get notification details
get
Update notification
put
Delete notification
delete
Test notification
post
Pause notifications
put
Unpause notifications
put
Pause notification
put
Unpause notification
put
Audit Log
Delete audit log
delete
Get audit log
get
Users
Get current user
get
Get all users
get
Update user password
put
Delete user
delete
Get user
get
Add user
post
Update user
put
Authentication
Get authentication token
post
Refresh authentication token
post
Log out user and revoke token
delete
Get SSO status
get
Server Configuration
Get all server configurations
get
Update server configurations
put
Credentials
Delete credentials in bulk
delete
Get all credentials
get
Delete remote system login encrypted record
delete
Get encrypted credentials
get
Add remote system login credentials
post
Update remote system login credentials
put
Scan
Delete all scan errors
delete
Get scan error log
get
Scan remote hosts
post
Scan remote hosts - ad hoc
post
Hosts
Delete hosts in bulk
delete
Get all hosts
get
Add hosts
post
Retry inactive hosts
post
Bulk tag hosts
put
Delete host
delete
Get host
get
Update host
put
Get host rollup
get
Host Results Info
Host kernel modules list
get
Host lastlog entry list
get
Host network listeners list
get
Host logged in users
get
Host process list
get
Host scheduled tasks list
get
Host systemd service list
get
Host user list
get
JumpHosts
Delete jump hosts in bulk
delete
Get all jump hosts
get
Delete jump host
delete
Get jump host
get
Add jump host
post
Update jump host
put
License
Delete license
delete
Add license entry
post
Update license entry
put
Refresh license entitlement
post
Reports
Host snapshot report
get
Scan performance report
get
Results
Delete results
delete
Get results
post
Result timeline
post
Delete all results
delete
Delete result
delete
Get result
get
Delete sandfly results for host
post
Delete host results for sandfly
post
Get host result summary
get
Get sandfly result summary
get
Result Profiles
Get result profiles
get
Create new result profile
post
Get a result profile
get
Update result profile
put
Delete a result profile
delete
Append results to result profile
post
Get result profiles for host
get
Export result profiles
post
Import result profiles
post
Delete result profiles
post
Sandflies
Get all registered sandflies
get
Add custom sandfly
post
Update custom sandfly
put
Activate sandflies in bulk
put
Backup all custom sandflies
get
Deactivate sandflies in bulk
put
Delete custom sandflies
delete
Delete custom sandfly
delete
Get sandfly
get
Activate sandfly
put
Deactivate sandfly
put
Reload all sandflies to default
post
Update system sandfly response options
put
SavedViews
Delete custom view
delete
Schedule
Delete schedules in bulk
delete
Get all schedules
get
Add a scan schedule
post
Run scheduled scan now
post
Deactivate schedules
put
Activate schedules
put
Deactivate schedule
put
Activate schedule
put
Delete schedule
delete
Get schedule
get
Update scheduled scan
put
SSH Hunter
Get SSH Hunter graph nodes
get
Get hosts with SSH public keys
get
Get SSH public key details for a host
get
Add SSH keys
post
Get SSH public key details
get
Bulk tag SSH keys
put
Tag SSH key
put
Get SSH keys host tags
post
Get hosts+tags for SSH keys
post
Get keys+tags for hosts
post
Get SSH public keys
get
Get users with SSH public keys
get
Get SSH public key details for a user
get
SSH Zones
Get SSH security zones
get
Create SSH security zone
post
Get an SSH security zone
get
Update SSH security zone
put
Delete SSH security zone
delete
Status
Get system status statistics
get
Get node status statistics
get
Get system status by tags over time
post
Purge task queues
delete
Get active queue names
get
Tags
Get all host tags
get
Get all sandfly tags
get
Get all SSH key tags
get
Threat Feeds
Get threat feeds
get
Create threat feed
post
Get threat feed details
get
Update threat feed
put
Delete threat feed
delete
Version
Get version
get
Whitelist
Get whitelist rules
get
Add Whitelist Rule
post
Get whitelist rule
get
Update whitelist rule
put
Delete Whitelist Rule
delete
Activate whitelist rules in bulk
put
Dectivate whitelist rules in bulk
put
Activate whitelist
put
Deactivate whitelist
put
Get whitelists for host
get
Delete Whitelist Rules
post
Delete user
delete
https://{sandfly-api-host}/v4/users/
{username}
Deletes a user.
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
JWT
Bearer
URL
Base URL
https://
sandfly-api-host
/v4
/users/{username}
RESPONSE
Click
Try It!
to start a request and see the response here!