Return to Homepage

Update Login

http
PUT /crates/{handle}/logins/{login}

Changes only the fields given; the rest keep their current values. Takes the fields of Add Sub-user except folder (a folder canโ€™t be renamed), plus enabled: false pauses the login and drops its connections, true lets it log in again. Switching a protocol off, making the login read-only, or changing allowed_ips drops its open connections; it can reconnect as the new settings allow.

The master login always sees the whole crate, so size_gb and read_only: true are refused for it with 422. ssh_password only stays on with ssh, and ftp_plain only with ftp on a plan that allows it.

Parameters

Field Type Required Description
enabled boolean No Pause (false) or resume (true) the login
size_gb integer or null No Sub-users only: the folderโ€™s cap in GB, null for none
read_only boolean No Sub-users only
ssh, ssh_password, file_keys, ftp, ftp_plain, webdav boolean No As in Add Sub-user
allowed_ips array No Replaces the allow list; [] allows any address

Response

json
{ "message": "Login updated." }

Snagged on something?

Our sysadmins answer tickets around the clock.