GetFileservers

Returns the fileservers from the logged in account
When returning billing info is on in the api, it will also return a section ‘BillingInfo’ for each fileserver. This returns if a fileserver is paid or not.

Authentication Methods


  1. With a username and password
  2. Using Kerberos
  3. With AMS username and password
Input Parameter Type Description
Token* String Security token
Email String Only needed with AMS Security Token
FilterBy Array Vault Label or Name
FilterValue Array Vault Label or NMSA
ShowUserList Boolean Returns the user list if true, default true
Output Parameter Type Description
FileServers FileServer[] Array of fileservers accessible by the account

*required

CURL EXAMPLE
curl -v 'https://secure.nomadesk.com/ctrller/api.php?Token=rrc1d3ntb53tt6b2vhail6rdtrsxov3v&Task=GetFileservers&ShowUserList=true'
RESPONSE
<Response>
    <Status>1</Status>
    <Message></Message>
    <Fileservers>
        <Fileserver>
            <Name>nmsa000002</Name>
            <Label>fileserverlabel1</Label>
            <InstallStatus>Installed</InstallStatus>
            <SendUserList>true</SendUserList>
            <Quota>1024</Quota>
            <QuotaWarningLevel>512</QuotaWarningLevel>
            <OwnerEmail>owner@example.com</OwnerEmail>
            <AdminEmail>admin@example.com</AdminEmail>
            <OpenEmail2Folder>true</OpenEmail2Folder>            
            <StorageApiUrl>https://example.com/storage/api.php</StorageApiUrl>
            <WebDAVUrl>https://webdav.example.com</WebDAVUrl>                
            <Favorite>true</Favorite>
        </Fileserver>
        <Fileserver>
            <Name>nmsa000004</Name>
            <Label>fileserverlabel2</Label>
            <InstallStatus>Installed</InstallStatus>
            <SendUserList>true</SendUserList>
            <Quota>1024</Quota>
            <QuotaWarningLevel>512</QuotaWarningLevel>                
            <OwnerEmail>owner@nomadesk.com</OwnerEmail>
            <OpenEmail2Folder>true</OpenEmail2Folder>
            <StorageApiUrl>https://example.com/storage/api.php</StorageApiUrl>
            <WebDAVUrl>https://webdav.example.com</WebDAVUrl>                
        </Fileserver>
    </Fileservers>
CURL EXAMPLE WITH FILTERING
curl -v 'https://secure.nomadesk.com/ctrller/api.php?Token=rrc1d3ntb53tt6b2vhail6rdtrsxov3v&Task=GetFileservers&FilterBy[]=Label&FilerValue=fileserverlabel1'
RESPONSE
<Response>
    <Status>1</Status>
    <Message></Message>
    <Fileservers>
        <Fileserver>
            <Name>nmsa000002</Name>
            <Label>fileserverlabel1</Label>
            <InstallStatus>Installed</InstallStatus>
            <SendUserList>true</SendUserList>
            <Quota>1024</Quota>
            <QuotaWarningLevel>512</QuotaWarningLevel>
            <OwnerEmail>owner@example.com</OwnerEmail>
            <AdminEmail>admin@example.com</AdminEmail>
            <OpenEmail2Folder>true</OpenEmail2Folder>            
            <StorageApiUrl>https://example.com/storage/api.php</StorageApiUrl>
            <WebDAVUrl>https://webdav.example.com</WebDAVUrl>                
            <Favorite>true</Favorite>
        </Fileserver>
    </Fileservers>