Version 8.3.8

Back | 

WsSecurityFilter

Returns list of security filters for the given account provided the account's security is enabled.

URL Format

/ws/ws_security_filter/api/{app_token}/mode/json/apiv/5?start={start}&end={end}

Parameters

Name Req Type Description
app_token string The api token for the given account. You can find the api token when navigating through account->api accounts
apiv integer The api version; only version 5 supported.
id int Will return the security filter that matches the provided id and that is associated to the app token
start int Will return a subset of available security filters. Used primarily for pagination. Default is set to 0
end integer Will return a subset of available security filters. Used primarily for pagination. Default is set to start+20 Zero-based exclusive index: E.G. &start=0&send=4 will return 5 security filters from the beginning.

Request Headers

Name

Possible Responses

  • 320 Security Filters Found
  • 102 Invalid app token.
  • 659 Invalid Client
  • 805 Security is not enabled for this account

Example Response

{
  "response": {
    "success": {
      "code": 320,
      "message": "Security Filters Found",
      "details": ""
    },
    "WsSecurityFilter": {
      "securityFilter": [
        {
          "id": 573,
          "clientID": 73,
          "dateAdd": "2014-01-13T15:26:55Z",
          "dateMod": "2014-01-13T19:42:10Z",
          "title": "Exclude South America",
          "description": "",
          "type": "exclude",
          "allowToken": "s045n2n8",
          "blackList": "",
          "whiteList": "",
          "securityFilterItems": [
            
          ]
        },
        {
          "id": 540,
          "clientID": 73,
          "dateAdd": "2012-09-06T15:19:46Z",
          "dateMod": "2013-01-23T18:25:14Z",
          "title": "Allow US and carribean",
          "description": "test",
          "type": "exclude",
          "allowToken": "ixetjv80",
          "allowIP": "",
          "blackList": "",
          "whiteList": "",
          "securityFilterItems": [
            {
              "id": 1419,
              "geoType": "country",
              "continent": "NORTH AMERICA",
              "country": "UNITED STATES",
              "region": "All",
              "city": "All"
            },
            {
              "id": 1420,
              "geoType": "country",
              "continent": "SOUTH AMERICA",
              "country": "GUYANA",
              "region": "All",
              "city": "All"
            }
          ]
        },
        {
          "id": 535,
          "clientID": 73,
          "dateAdd": "2012-08-23T19:43:39Z",
          "dateMod": "2012-08-27T16:56:50Z",
          "title": "Arif-usa",
          "description": "",
          "type": "exclude",
          "allowToken": "ej86qrp6",
          "allowIP": "",
          "blackList": "74.72.226.75",
          "whiteList": "",
          "securityFilterItems": [
            {
              "id": 1414,
              "geoType": "city",
              "continent": "NORTH AMERICA",
              "country": "UNITED STATES",
              "region": "ALABAMA",
              "city": "ABBEVILLE"
            }
          ]
        }
      ],
      "currentCount": 3,
      "totalCount": 27
    }
  }
}