Update FTP Account

Updates an existing FTP account.

The Management API uses partial updates (PATCH), meaning you only need to provide the fields you want to change.

Fields omitted from the request remain unchanged.

Required Scope

ftpaccount.update

Endpoint

PATCH /ftpaccounts

Example Request

http PATCH https://api.ftpgrid.com/ftpaccounts \
Authorization:"Bearer YOUR_TOKEN" \
Id:=1234 \
Description="Updated warehouse camera" \
Enabled:=false

Request Fields

Field	Type	Required	Description
Id	integer	Yes	FTP account ID
Username	string	No	FTP/SFTP username
Password	string	No	Password for authentication
AccessRights	string	No	RO or RW
Chroot	string	No	Chroot directory
Description	string	No	Internal description
Enabled	boolean	No	Enable or disable the account
RsaKey	string	No	SSH public key

Partial Update Behavior

Only supplied fields are updated.

For example:

http PATCH https://api.ftpgrid.com/ftpaccounts \
Authorization:"Bearer YOUR_TOKEN" \
Id:=1234 \
Enabled:=false

will only disable the account while leaving all other settings unchanged.

Example Response

{
    "rslt": "OK"
}

The API backend will return "OK", even if no fields are updated.

Notes

• Passwords are never returned by the API
• Updating the password immediately invalidates the previous password
• Chroot paths must use Unix-style paths
• Windows path separators (\) are not supported
• SSH public keys must be provided in OpenSSH public key format
• Disabling an account immediately blocks FTP, FTPS, SFTP, and SCP access