Edit Virtual server

<< Click to Display Table of Contents >>

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

Edit Virtual server

Modifies the configuration of a virtual server.

 

Request

Method

URL

POST

/smserver/smsadm.EditVServer

RAW

POST /smserver/smsadm.EditVServer 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

 

[

"_id" : "Z5ENP7AZMPRERDQHUEWBSICAKI",

           "Name" : "new",

           "MaxUsers" : 25,

           "AllowedRoots" : [

               "C:\\"

           ],

           "AllowedUserTypes" : [

               "SMS",

               "Windows",

               "AD"

           ],

           "AllowedVFSTypes" : [

               "Disk",

               "DiskAES256"

           ],

           "AllowDataCollection" : true,

           "vserver" : "default"

       }

]

Explained

Modifies the configuration of a specific virtual server

 

_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

AllowDataCollection: allows the virtual server to send anonymous data to Syncplify for statistical purposes

 

Response

Method

URL

RAW

Accept-Encoding: synlz,gzip

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

 

 

{"result":[

   {

       "Result" : 1,

       "ResultMsg" : "Deleted",

   },

],"id":7721}

Explained

Result:

  1 = success

  any other value different from 1 = error

 

ResultMsg: a friendly message (success or error message) explaining what happened