Read Stats

<< Click to Display Table of Contents >>

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

Read Stats

Reads the (aggregated) statistics for a virtual server.

 

Request

Method

URL

POST

/smserver-default/sms.ReadStats

RAW

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

 

[

 {

   "nodes" : [

               "Z5ENP7AZMPRERDQHUEWBSICAKI",

               "NPFS3SNTFBLUVFJNCLUZPUEB4E"

             ]

 }

]

Explained

Retrieves the aggregated statistics for one or more nodes of the current virtual server.

 

Payload: a one-element JSON array containing an object that lists all the nodes for which we are requesting the statistics.

 

Response

Method

URL

RAW

Accept-Encoding: synlz,gzip

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

 

 

{"result":[

{

       "_id" : "A3ATF2VLLH3U7FCXO65XI6Q3QE",

       "Overall" : {

           "Started" : "2016-01-26T09:06:15",

           "ConnectionPeak" : 1,

           "SSHSessions" : 0,

           "FTPSessions" : 1,

           "BListedSSH" : 0,

           "BListedFTP" : 0,

           "BListHits" : 0,

           "BLHitsByHammer" : 0,

           "BLHitsByAuth" : 0,

           "BLHitsByProto" : 0,

           "TransferStats" : {

               "TotBytesUp" : 1.1220703125000000,

               "TotBytesDown" : 4.1757812500000000,

               "TotFileUp" : 0,

               "TotFileDown" : 0

           }

       },

       "SinceLastStart" : {

           "Started" : "2016-02-05T21:47:24",

           "ConnectionPeak" : 0,

           "SSHSessions" : 0,

           "FTPSessions" : 0,

           "BListedSSH" : 0,

           "BListedFTP" : 0,

           "BListHits" : 0,

           "BLHitsByHammer" : 0,

           "BLHitsByAuth" : 0,

           "BLHitsByProto" : 0,

           "TransferStats" : {

               "TotBytesUp" : 0,

               "TotBytesDown" : 0,

               "TotFileUp" : 0,

               "TotFileDown" : 0

           }

       }

   }

],"id":772674711}

Explained

Overall: since the first time the virtual server was started

SinceLastStart: since the last time the virtual server was restarted

 

Started: when was it started or restarted in UTC (if multiple nodes, the smaller date will be reported)

ConnectionPeak: maximum number of concurrent connections reached

SSHSessions: how many SSH/SFTP sessions have been served

FTPSessions: how many FTP(E/S) sessions have been served

BListedSSH: how many clients were blacklisted by the SSH/SFTP protocol

BListedFTP: how many clients were blacklisted by the FTP(E/S) protocol

BListHits: how many blacklist hits in total

BLHitsByHammer: how many blacklist hits were caused by "hammering" attacks

BLHitsByAuth: how many blacklist hits were caused by authentication-related issues

BLHitsByProto: how many blacklist hits were caused by protocol violations

TransferStats: {

TotBytesUp: total number of bytes uploaded to the virtual server

TotBytesDown: total number of bytes downloaded from the virtual server

TotFileUp: total number of files uploaded to the virtual server

TotFileDown: total number of files downloaded from the virtual server

}