...
- Blacklisted signatures: These are the signatures that have bot characteristics and have been detected by ShieldSquare.
- Deleted signatures: Every signature blocked has an expiration time. Throughout the document, a deleted signature refers to the expired signature.
- Cron Job: The software utility Cron is a time-based job-scheduler in Unix-type computer Operating Systems like UNIX, Linux, FreeBSD and Darwin (Mac OS X). People who set up and maintain software environments use cron to schedule jobs to run periodically at fixed times, dates, or intervals.
- JSON: JavaScript Object Notation is an open standard format that uses human-readable text to transmit data objects consisting of attribute–value pairs.
- IP Feed: This has been interchangeably used with ‘Feed’ and ‘ShieldSquare IP Feed’.
Info | ||
---|---|---|
| ||
|
Feed-Based Protection Summary
The endpoint for the Feed-Based Protection is as follows:
Info |
---|
Services provided by IP Feed:
- getipfeed: Returns a list of JSON objects containing blacklisted and deleted signatures related to the Subscriber ID along with additional information.
- getfeedcount: Returns the count of the feed related to the Subscriber ID.
- getfeedbackup: Returns the last feed sent while callinggetipfeedservice. This can be invoked if the last feed is lost.
Feed-Based Protection Details
1.getipfeed
This feed returns a JSON Packet containing signatures that were blacklisted or deleted, and other information related to it.
Parameters to be passed to the feed: Subscriber ID. Refer to the template below:
Info |
---|
|
Response:
The feed will return a JSON packet with the list of signatures that were blacklisted or deleted (Parent Node) and each signature with its description (Child Node). On successful call, the JSON response will have the following nodes as shown below:
JSON Node | Description |
---|---|
Description | A small description on whether the signature was blacklisted or deleted by ShieldSquare. This field is just for informational purposes. |
Operation | Can have values ADD/ DEL based on whether the signature was blacklisted (ADD) or deleted (DEL). |
IP | The IP address that has been associated with the blacklisted or deleted signature. |
Updated Time | Time at which the signature was blacklisted or blacklist expired by ShieldSquare. DD/MM/YYYY-HH::MM:SS is the time format. |
Rule | This field is present for backward compatibility reasons and can be ignored. |
TTL | TTL is acronym for 'Time To Live'. It is the time in seconds for which the corresponding signature should be blocked. This will be present only for blacklisted signatures. |
Bot-Type | The value is one of :
|
Preferred action | The value is one of :
This indicates the action that needs to be taken for the BOTS. This values are based on the preferences set on theBot Response List page in the ShieldSquare Dashboard. |