Sign in

v1

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

Add a share

Adds a new share. The share id will be auto-generated

post/user/shares

Request body

idstring

auto-generated unique share identifier

namestring
descriptionstring

optional description

scope1 | 2

Options:

  • 1 - read scope
  • 2 - write scope
pathsstring[]

paths to files or directories, for share scope write this array must contain exactly one directory. Paths will not be validated on save so you can also create them after creating the share

usernamestring
created_atinteger

creation time as unix timestamp in milliseconds

updated_atinteger

last update time as unix timestamp in milliseconds

last_use_atinteger

last use time as unix timestamp in milliseconds

expires_atinteger

optional share expiration, as unix timestamp in milliseconds. 0 means no expiration

passwordstring

optional password to protect the share. The special value "[redacted]" means that a password has been set, you can use this value if you want to preserve the current password when you update a share

max_tokensinteger

maximum allowed access tokens. 0 means no limit

used_tokensinteger
allow_fromstring[]

Limit the share availability to these IP/Mask. IP/Mask must be in CIDR notation as defined in RFC 4632 and RFC 4291, for example "192.0.2.0/24" or "2001:db8::/32". An empty list means no restrictions

Example request

{
  "paths": [
    "/dir1",
    "/dir2/file.txt",
    "/dir3/subdir"
  ],
  "allow_from": [
    "192.0.2.0/24",
    "2001:db8::/32"
  ]
}

Response

successful operation

messagestring

message, can be empty

errorstring

error description if any