v1

latestOpenAPI 3.0.3AGPL-3.0-only2026-07-17120116247.0 KB
user APIs

Save a TOTP config

Saves the specified TOTP config for the logged in user

post/user/totp/save

Request body

enabledboolean
config_namestring

This name must be defined within the "totp" section of the SFTPGo configuration file. You will be unable to save a user/admin referencing a missing config_name

protocolsMFAProtocols[]

TOTP will be required for the specified protocols. SSH protocol (SFTP/SCP/SSH commands) will ask for the TOTP passcode if the client uses keyboard interactive authentication. FTP has no standard way to support two factor authentication, if you enable the FTP support, you have to add the TOTP passcode after the password. For example if your password is "password" and your one time passcode is "123456" you have to use "password123456" as password. WebDAV is not supported since each single request must be authenticated and a passcode cannot be reused.

Response

successful operation

messagestring

message, can be empty

errorstring

error description if any