Bind Util function

<< Click to Display Table of Contents >>

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

Bind Util function

Verifies the availability of a binding on the server.

 

Request

Method

URL

POST

/smserver/smsadm.BindUtil

RAW

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

 

[

{

           "MachineId" : "Z5ENP7AZMPRERDQHUEWBSICAKI",

           "testaddr" : "0.0.0.0",

           "testport" : 1022

           "excvserver" : "default2"

}

]

Explained

Used to verify if an IP/port if already in use or not.

 

MachineID: machine onto which the binding test has to be run

testaddr: IP address to be tested

testport: port to be tested

excvserver: virtual server to exclude from the test (in case we need it to "edit" that specific virtual server)

 

Response

Method

URL

RAW

Accept-Encoding: synlz,gzip

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

 

 

{"result":[

{

       "Result" : 1,

       "ip" : "0.0.0.0",

       "port" : 1022

   }

],"id":7721}

Explained

Result: 1 means OK, the binding is available

ip: the IP we originally requested

port: the port we originally requested

 

Response

Method

URL

RAW

Accept-Encoding: synlz,gzip

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

 

 

{"result":[

{

       "Result" : 0,

       "VServer" : "default",

       "proto" : "SSH",

       "ip" : "0.0.0.0",

       "port" : 22

   }

],"id":7721}

Explained

Result: 0 means that the binding is NOT available

VServer: virtual server that conflicts with our request

proto: protocol that conflicts with our request

ip: IP address we requested

port: port we requested