Policy information

API URL

<ips-api-base>/policies?<filters

ips-api-base>/policies/<policy-name>?<filters

URL parameters

concise_info: (optional) - true(default)|false

policy_type: (mandatory)- ips_default|ips_custom

Sample curl request

Fetch ALL policies
curl -gsvk -H "$c" --header "Accept: application/json" "https://<host>/ wsapis/v2.0.0/ips/policies
Fetch ALL Default policies
curl -gsvk -H "$c" --header "Accept: application/json" "https://<host>/ wsapis/v2.0.0/ips/policies?policy_type=ips_default"
Fetch ALL Custom policies
curl -gsvk -H "$c" --header "Accept: application/json" "https://<host>/ wsapis/v2.0.0/ips/policies?policy_type=ips_custom"
Fetch a single Default policy
curl -gsvk -H "$c" --header "Accept: application/json" "https://<host>/ wsapis/v2.0.0/ips/policies/Comprehensive?policy_type=ips_default"<code?
Fetch a single custom policy
curl -gsvk -H "$c" --header "Accept: application/json" "https://<host>/ wsapis/v2.0.0/ips/policies/MyPolicy?policy_type=ips_custom"

Authentication

Standard WSAPI authentication

Method

GET

Response

HTTP OK with JSON representation of policy

{
"match_criteria": {
"max_confidence": 10,
"max_severity": 10,
"attack_target": [
"client",
"server"
],
"min_confidence": 0,
"min_severity": 0,
"hash": "8292f7028a7c4e07765fc45000fb1aa1b44954292d2fe673bef8f324d1f547b2"
},
"interfaces": [
{
"name": "A",
"state": "applied"
},
{
"name": "B",
"state": "empty"
}
],
"last_updated": "2014/04/25",
"is_active": true,
"ruleset": {
"custom": {
"block_count": 10,
"active_count": 0,
"hash": "76e8430845b848ea9a61dad6a5d22f710096e56ce25694353ac3313cef30f2ee",
"rule_count": 10
},
"hash": "d52df14ae5c086e3102c832bd6b2714cea2c3a3d0940e039871cb7a9e9a119d8",
"content": {
"block_count": 8128,
"version": "1025.242",
"rule_count": 8263
}
},
"policy_name": "ComprehensiveClone",
"insert_time": "2020-06-11T17:55:41.553101",
"is_writable": false,
"is_default": false,
"policy_version": 2,
"policy_type": "ips_custom",
"inclusion_list": {},
"update_time": "2020-06-12T18:29:47.813948",
"exclusion_list": {
"rules": []
},
"hash": "acd9882335d0ca0ca3b485b3b0ecb5fa5cf90cedde02dc87454c4a6a83ecce36"
}

Response mime type

application/json