API - Getting Started

Getting Started - Sandfly API

Sandfly API

알림
감사 로그
- Delete audit logdelete
- Get audit logget
Users
Authentication
Server Configuration
- Get all server configurationsget
- Update server configurationsput
Credentials
스캔
Hosts
Host Results Info
JumpHosts
라이선스
LLM Analysis
리포트
- Host snapshot reportget
- Scan performance reportget
Results
결과 프로파일
Sandflies
SavedViews
- Delete custom viewdelete
Schedule
SSH Hunter
SSH Zones
Status
Tags
Threat Feeds
Version
- Get versionget
Whitelist

Update user password

put https://{sandfly-api-host}/v4/users/password/{username}

Updates the password of a user.

Path Params

username

string

required

username to update password

Body Params

User json blob.

password

required

new password string

old_password

password

current password string; required when a user is changing their own password

Responses

Response body

object

created_date

date-time

required

Date this user was created

string

required

Email address for the user.

full_name

string

required

Full name of user.

last_login_date

date-time | null

required

Last login date/time for this user.

last_login_ip

string

required

Last login IP address we saw this user.

logins

array of strings

required

An comma delimited array of the dates and locations this user has ever logged in from.

logins*

logins_failed

array of strings

required

An comma delimited array of the dates and locations this user has failed logged in from.

logins_failed*

logins_failed_count

int64

required

A counter of the number of failed logins from the last successful login. Used to detect brute forcers.

password

string

required

User's password (used for setting during creation; not returned)

preferences

string

required

Preferences for user.

roles

array

required

Roles this user has access to.

roles*

sso

boolean

required

False for a local Sandfly user, true for an SSO user. Cannot change once user is created.

username

string

required

Username

Response body

object

data

string

required

Data that can go along with the status.

detail

string

required

Extended explanation of status.

formattedDetail

string

Optional additional details about the status (typically an error) that, if present and not an empty string, should be displayed as pre-formatted, monospaced text.

status

int32

required

100 to 599

HTTP status code.

title

string

required

Short description of status.

Response body

object

data

string

required

Data that can go along with the status.

detail

string

required

Extended explanation of status.

formattedDetail

string

Optional additional details about the status (typically an error) that, if present and not an empty string, should be displayed as pre-formatted, monospaced text.

status

int32

required

100 to 599

HTTP status code.

title

string

required

Short description of status.

Response body

object

data

string

required

Data that can go along with the status.

detail

string

required

Extended explanation of status.

formattedDetail

string

Optional additional details about the status (typically an error) that, if present and not an empty string, should be displayed as pre-formatted, monospaced text.

status

int32

required

100 to 599

HTTP status code.

title

string

required

Short description of status.

Response body

object

data

string

required

Data that can go along with the status.

detail

string

required

Extended explanation of status.

formattedDetail

string

Optional additional details about the status (typically an error) that, if present and not an empty string, should be displayed as pre-formatted, monospaced text.

status

int32

required

100 to 599

HTTP status code.

title

string

required

Short description of status.

Updated 7 days ago

Get all users

Delete user

이 페이지가 도움이 되었나요?

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://sandfly-api-host/v4/users/password/username \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 7 days ago

Get all users

Delete user

이 페이지가 도움이 되었나요?

API - Getting Started
Getting Started - Sandfly API

Sandfly API
Notifications
Unpause notificationput
Pause notificationput
Unpause notificationsput
Pause notificationsput
Test notificationpost
Delete notificationdelete
Update notificationput
Get notification detailsget
Create notificationpost
Get notificationsget
Update syslog entryput
Get syslog entryget
Delete syslog entrydelete
Add syslog entrypost
Get all syslog entriesget
Update email entryput
Get email entryget
Delete email entrydelete
Test email entrypost
Add email entrypost
Get all email alertsget
Audit Log
Get audit logget
Delete audit logdelete
Users
Update userput
Add userpost
Get userget
Delete userdelete
Update user passwordput
Get all usersget
Get current userget
Authentication
Get SSO statusget
Log out user and revoke tokendelete
Refresh authentication tokenpost
Get authentication tokenpost
Server Configuration
Update server configurationsput
Get all server configurationsget
Credentials
Update remote system login credentialsput
Add remote system login credentialspost
Get encrypted credentialsget
Delete remote system login encrypted recorddelete
Get all credentialsget
Delete credentials in bulkdelete
Scan
Scan remote hosts - ad hocpost
Scan remote hostspost
Get scan error logget
Delete all scan errorsdelete
Hosts
Get host rollupget
Update hostput
Get hostget
Delete hostdelete
Bulk tag hostsput
Retry inactive hostspost
Add hostspost
Get all hostsget
Delete hosts in bulkdelete
Host Results Info
Host user listget
Host systemd service listget
Host scheduled tasks listget
Host process listget
Host logged in usersget
Host network listeners listget
Host lastlog entry listget
Host kernel modules listget
JumpHosts
Update jump hostput
Add jump hostpost
Get jump hostget
Delete jump hostdelete
Get all jump hostsget
Delete jump hosts in bulkdelete
License
Refresh license entitlementpost
Update license entryput
Add license entrypost
Delete licensedelete
LLM Analysis
Wait for LLM analysisget
Add chat to LLM analysisput
Delete LLM analysisdelete
Get LLM analysisget
Bulk delete LLM analysespost
Begin LLM analysispost
Get LLM analysesget
Reports
Scan performance reportget
Host snapshot reportget
Results
Get sandfly result summaryget
Get host result summaryget
Delete host results for sandflypost
Delete sandfly results for hostpost
Get resultget
Delete resultdelete
Delete all resultsdelete
Result timelinepost
Get resultspost
Delete resultsdelete
Result Profiles
Delete result profilespost
Import result profilespost
Export result profilespost
Get result profiles for hostget
Append results to result profilepost
Delete a result profiledelete
Update result profileput
Get a result profileget
Create new result profilepost
Get result profilesget
Sandflies
Update system sandfly response optionsput
Reload all sandflies to defaultpost
Deactivate sandflyput
Activate sandflyput
Get sandflyget
Delete custom sandflydelete
Delete custom sandfliesdelete
Deactivate sandflies in bulkput
Backup all custom sandfliesget
Activate sandflies in bulkput
Update custom sandflyput
Add custom sandflypost
Get all registered sandfliesget
SavedViews
Delete custom viewdelete
Schedule
Abort schedule runput
Update scheduled scanput
Get scheduleget
Delete scheduledelete
Activate scheduleput
Deactivate scheduleput
Activate schedulesput
Deactivate schedulesput
Run scheduled scan nowpost
Add a scan schedulepost
Get all schedulesget
Delete schedules in bulkdelete
SSH Hunter
Get SSH public key details for a userget
Get users with SSH public keysget
Get SSH public keysget
Get keys+tags for hostspost
Get hosts+tags for SSH keyspost
Get SSH keys host tagspost
Tag SSH keyput
Bulk tag SSH keysput
Get SSH public key detailsget
Add SSH keyspost
Get SSH public key details for a hostget
Get hosts with SSH public keysget
Get SSH Hunter graph nodesget
SSH Zones
Delete SSH security zonedelete
Update SSH security zoneput
Get an SSH security zoneget
Create SSH security zonepost
Get SSH security zonesget
Status
Get active queue namesget
Purge task queuesdelete
Get system status by tags over timepost
Get node status statisticsget
Get system status statisticsget
Tags
Get all SSH key tagsget
Get all sandfly tagsget
Get all host tagsget
Threat Feeds
Delete threat feeddelete
Update threat feedput
Get threat feed detailsget
Create threat feedpost
Get threat feedsget
Version
Get versionget
Whitelist
Delete Whitelist Rulespost
Get whitelists for hostget
Deactivate whitelistput
Activate whitelistput
Dectivate whitelist rules in bulkput
Activate whitelist rules in bulkput
Delete Whitelist Ruledelete
Update whitelist ruleput
Get whitelist ruleget
Add Whitelist Rulepost
Get whitelist rulesget

200User password updated.

400Error updating user.

403Not allowed to set password for the requested user, or incorrect existing password when changing own password.

404User not found.

defaultUnexpected error