GET
/user/shares/{id}Get share by ID
Returns the details of a specific sharing link owned by the logged in user
idstringrequired
the share id
200successful operation
allow_fromarray<string>optional
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
created_atintegeroptional
creation time as unix timestamp in milliseconds
descriptionstringoptional
optional description
expires_atintegeroptional
optional share expiration, as unix timestamp in milliseconds. 0 means no expiration
groupsarray<object>optional
idstringoptional
auto-generated unique share identifier
last_use_atintegeroptional
last use time as unix timestamp in milliseconds
max_tokensintegeroptional
maximum allowed access tokens. 0 means no limit
namestringoptional
optionsobjectoptional
passwordstringoptional
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
pathsarray<string>optional
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
scopeintegeroptional
Scopes:
* `1` - Read
* `2` - Write
* `3` - Read/Write
updated_atintegeroptional
last update time as unix timestamp in milliseconds
used_tokensintegeroptional
user_permissionsintegeroptional
Computed bitmask representing the share permissions. 1 means Read, 2 Write, 4 Delete
usernamestringoptional
Owner of the share. Only the owner can update paths and manage group membership
400Bad Request
errorstringoptional
error description if any
messagestringoptional
message, can be empty
401Unauthorized
errorstringoptional
error description if any
messagestringoptional
message, can be empty
403Forbidden
errorstringoptional
error description if any
messagestringoptional
message, can be empty
404Not Found
errorstringoptional
error description if any
messagestringoptional
message, can be empty
500Internal Server Error
errorstringoptional
error description if any
messagestringoptional
message, can be empty
defaultUnexpected Error
errorstringoptional
error description if any
messagestringoptional
message, can be empty
Error handling
A 400 is returned: Bad Request. A 401 is returned: Unauthorized. A 403 is returned: Forbidden. A 404 is returned: Not Found. A 500 is returned: Internal Server Error. Any other status is an error: Unexpected Error.