Kill session

<< Click to Display Table of Contents >>

Navigation:  Managing Syncplify.me Server! > REST API > Admin API > Sessions and Statistics >

Kill session

Terminates one or all currently active sessions.

 

Request

Method

URL

POST

/smserver-default/sms.KillSess

RAW

POST /smserver-default/sms.KillSess 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

 

[

{

           "sessionid" : "SLTWTDNM7CFEPDSM3Q54LQVK5Q.KKD24ZMGEWETF2AEBXW2XRSG4"

}

]

Explained

Terminates an existing/current client session.

 

Note: the session ID must represent an existing session, as returned by GetSession

 

Response

Method

URL

RAW

Accept-Encoding: synlz,gzip

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

 

 

{"result":[

{

           "Result" : 1

       }

],"id":772674711}

Explained

Result:

  1 = success

  any other value different from 1 = error

 

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

 

OR

 

Request

Method

URL

POST

/smserver-default/sms.KillSess

RAW

POST /smserver-default/sms.KillSess 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

 

[

{

           "sessionid" : "ALL",

           "nodes" : []

}

]

Explained

Terminates all current client sessions connected to one or more nodes belonging to the current virtual server.

 

Note: the "nodes" parameter may contain one or mode IDs of nodes belonging to the current virtual server

 

Response

Method

URL

RAW

Accept-Encoding: synlz,gzip

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

 

 

{"result":[

{

           "Result" : 1

       }

],"id":772674711}

Explained

Result:

  1 = success

  any other value different from 1 = error

 

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