GetFolderLink

Generates a FolderLink

When logging onto the API with the AccessToken the Message field will be returned. These can be used to construct an Email or can be displayed to the user.

Authentication Methods


  1. With a username and password
  2. Using Kerberos
Input Parameter Type Description
Token* String Security token
FileserverName* String FileServer name
Path* String File to link
ExpiryDays Int Number of days after which filelink expires Note -1 denotes unlimited
Notify Boolean Whether or not the owner should receive a notification email when the filelink has been accessed
Message String Message of the filelink
ExpiryDownloads Int Amount of downloads after which to expire. Note -1 denotes unlimited.
AccessPassword String Password to protect FileLink access.
Note: empty string ‘’ denotes not password protected
Access AccessType Possible access types: PreviewOnly, ReadWrite, ReadOnly
RequireIdent Boolean Require the user to be identified
Output Parameter Type Description
FolderLink String Link to the FolderLink

*=required

CURL EXAMPLE
curl -v 'https://example.com/ctrller/api.php?Token=rrc1d3ntb53tt6b2vhail6rdtrsxov3v&Task=GetFolderLink&FileserverName=nmsa000001&Path=%2Ffile.txt&ExpiryDays=5&Notify=true&Message=messagetext'
RESPONSE
<Response>
    <Status>1</Status>
    <Message></Message>
<FolderLink>https://example.com/FolderLink/b0f15b71-af73-afb0-0deb-5affa77ac94e</FileLink>
</Response>