Read BlackList

<< Click to Display Table of Contents >>

Navigation:  Managing Syncplify.me Server! > REST API > Admin API > Blacklist Management >

Read BlackList

Reads the entire blacklist.

 

Request

Method

URL

POST

/smserver-default/sms.ReadBlackList

RAW

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

 

[

{}

]

Explained

Reads the entire blacklist.

 

Payload: a JSON array containing a single empty object.

 

Response

Method

URL

RAW

Accept-Encoding: synlz,gzip

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

 

 

{"result":[

[

       {

           "_id" : "194.244.110.15/24",

           "TimeStamp" : "2016-02-02T22:39:58",

           "Persistence" : "Permanent",

           "HitCount" : 0

       },

       {

           "_id" : "194.244.111.11",

           "TimeStamp" : "2016-02-02T22:55:12",

           "Persistence" : "Temporary",

           "HitCount" : 0

       }

   ]

],"id":772674711}

Explained

A JSON array containing all blacklisted IP addresses and networks; one JSON object for each blacklisted item specifying:

 

_id: the unique ID, which is the blacklisted IP address or network

TimeStamp: when (in UTC) the item was blacklisted

Persistence: "Permanent" or "Temporary"

HitCount: how many times someone from this IP or network tried to connect when it was already blacklisted