Return to Homepage

Add Sub-user

http
POST /crates/{handle}/logins

Adds a sub-user with a folder of its own at the top of the crate, named <handle>-<folder>. Returns its password, once. The master login sees the new folder too. 422 when the folder is taken or isn’t a valid name, 400 when the plan’s sub-user limit is reached.

Parameters

Field Type Required Default Description
folder string Yes Lowercase letters, digits and hyphens, up to 32 characters
size_gb integer No none Cap on the folder’s size in GB, up to the crate’s size
read_only boolean No false Can read and download but not change anything
ssh boolean No true SFTP, SCP, rsync, borg and restic
ssh_password boolean No false Allow the password over SSH (keys always work)
file_keys boolean No true Honor keys the login keeps in its own .ssh/authorized_keys
ftp boolean No false FTPS
ftp_plain boolean No false Also unencrypted FTP, when the plan allows it (plain_ftp_allowed); ignored otherwise
webdav boolean No true WebDAV over HTTPS
allowed_ips array No [] Addresses and CIDR ranges the login may connect from (up to 50); empty allows any

Response (201)

json
{
  "login": "c7xk2m9p-backups",
  "password": "Kt7wq2Xn9pRz4Vm8Hs3bYc6D",
  "message": "Sub-user added. Its password is shown only now."
}

Snagged on something?

Our sysadmins answer tickets around the clock.