Load Virtual server

<< Click to Display Table of Contents >>

Navigation:  Managing Syncplify.me Server! > REST API > SuperAdmin API > Virtual server >

Load Virtual server

Loads the configuration of a virtual server.

 

Request

Method

URL

POST

/smserver/smsadm.LoadVServer

RAW

POST /smserver/smsadm.LoadVServer HTTP/1.1

Cache-Control: no-cache

Connection: Keep-Alive

Pragma: no-cache

Content-Type: application/json; charset=UTF-8

Accept: */*

Authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

 

[

       {

           "vserver" : "newvserver",

       }

]

Explained

Loads a virtual server profile.

 

vserver: the virtual server name (id) to be loaded

 

Response

Method

URL

RAW

Accept-Encoding: synlz,gzip

Content-Type: application/json; charset=UTF-8

 

 

{"result":[

   {

       "_id" : "default",

       "Name" : "default",

       "MaxUsers" : 25,

       "AllowedRoots" : [

           "C:\\"

       ],

       "AllowedUserTypes" : [

           "SMS",

           "Windows",

           "WinGroup",

           "AD",

           "ADGroup"

       ],

       "AllowedVFSTypes" : [

           "Disk",

           "DiskAES256"

       ]

       "currentUser" : 2

   }

],"id":7721}

Explained

_id: unique virtual server name

Name: Friendly name

MaxUsers: maximum number of users that can be created in this virtual server

AllowedRoots: used to restrict the root folders of this virtual server's user accounts (example: ["C:\\","D:\\Data\\"])

AllowedUserTypes: types of user profiles that can be created

AllowedVFSTypes: types of VFS items that can be created

currentUser:  current number of users (count)