Filter List Resource

Description

Resource for querying zone filter list.

GET /zones/:ID/filter_list

Query the filter list for the specified zone. This is a paged query. If used with no query parameters, defaults to showing the current active filter list. Parameters can be used to filter this and show historical data.

GET Parameters

Name	Required	Type	Description	Default Value
:ID	Yes	URL Parameter	The unique numeric ID of the zone.
start_time	No	Query Parameter	The earliest time to search for filter list entries in ISO 8601 format. If used you must include an end_time value as well.	Five minutes ago
end_time	No	Query Parameter	The latest time to search for filter list entries in ISO 8601 format. If used you must include a start_time value as well.	Current time
src	No	Query parameter	Search by source IP/prefix. Limits results to filter list entries with the source address equal to or contained by src
dst	No	Query parameter	Search by destination IP/prefix. Limits results to filter list entries with the source address equal to or contained by dst
ddos_type	No	Query parameter	Search by attack type. Expects a numeric value for an attack type. Leave unset or set to '0' to match all attack types
mode	No	Query parameter	Search by filter list mode. Limits results to filter list entries in the selected mode. Must be one of "auto", "monitor".
Page Params

GET Response Values

Returns a collection of filter list entries.

Example GET Request

 GET /zones/0/filter_list

Example GET Response

{
	"rows": 2,
	"data": [
		{
			"id": 17144,
			"src": "101.168.155.1",
			"dst": "15.2.1.41",
			"start_time": "2024-04-26T20:07:26Z",
			"end_time": "2024-04-26T20:37:07Z",
			"ddos_type": 8,
			"mode": "auto",
			"device_id": 2,
			"zone_id": 0,
			"device_name": "RE100-2",
			"device_resource": "/devices/2",
			"zone_name": "Default",
			"zone_resource": "/zones/0"
		},
		{
			"id": 17145,
			"src": "101.168.155.1",
			"dst": "15.3.1.7",
			"start_time": "2024-04-26T20:07:26Z",
			"end_time": "2024-04-26T20:37:07Z",
			"ddos_type": 8,
			"mode": "auto",
			"device_id": 2,
			"zone_id": 0,
			"device_name": "RE100-2",
			"device_resource": "/devices/2",
			"zone_name": "Default",
			"zone_resource": "/zones/0"
		}
	],
	"start": 0
}