SFTPGo Octri Preview
PUT/admin/changepwd

Change the admin password

Changes the password for the authenticated user's admin account after verifying the current password. Supply current_password for verification and new_password as the replacement; the schema specifies no password-format constraints.

2 body fields

The current and replacement passwords for the authenticated user's admin account.

current_passwordstringoptional
The current password, used to verify the authenticated user's identity.
new_passwordstringoptional
The replacement password for the admin account.

6 status codes
200Returns a JSON object with `error` and `message` fields.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
401Returned when the request is unauthorized. The response includes `error` and `message` fields.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
403Returned when the operation is forbidden. The response includes `error` and `message` fields.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
409Returned when the password change conflicts with the current state. The response includes `error` and `message` fields.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
500Returned when an internal server error occurs. The response includes `error` and `message` fields.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
defaultUnexpected Error
errorstringoptional
error description if any
messagestringoptional
message, can be empty

Error handling

A 401 is returned when the request is unauthorized; a 403 when the operation is forbidden; a 409 when the change conflicts with the current state; and a 500 when an internal server error occurs. The password change requires current_password for verification; provide new_password as the replacement.