Avi BotDetectionPolicy Object API
CLI ``` - configure botdetectionpolicy - show botdetectionpolicy ```
Contact Info: support@avinetworks.com
Version: 21.1.6
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /botdetectionpolicypost /botdetectionpolicydelete /botdetectionpolicy/{uuid}get /botdetectionpolicy/{uuid}patch /botdetectionpolicy/{uuid}put /botdetectionpolicy/{uuid}
Up
get /botdetectionpolicy
(botdetectionpolicyGet)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"user_consolidator_ref" : "aeiou",
"user_agent_detector" : {
"enabled" : true
},
"description" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"ip_reputation_detector" : {
"system_ip_reputation_mapping_ref" : "aeiou",
"enabled" : true,
"ip_reputation_db_ref" : "aeiou"
},
"allow_list" : {
"rules" : [ {
"condition" : {
"cookie" : {
"match_criteria" : "aeiou",
"name" : "aeiou",
"value" : "aeiou",
"match_case" : "aeiou"
},
"method" : {
"match_criteria" : "aeiou",
"methods" : [ "aeiou" ]
},
"host_hdr" : {
"match_criteria" : "aeiou",
"value" : [ "aeiou" ],
"match_case" : "aeiou"
},
"ip_reputation_type" : {
"reputation_types" : [ "aeiou" ],
"match_operation" : "aeiou"
},
"query" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_str" : [ "aeiou" ],
"match_case" : "aeiou"
},
"vs_port" : {
"match_criteria" : "aeiou",
"ports" : [ "" ]
},
"hdrs" : [ {
"match_criteria" : "aeiou",
"hdr" : "aeiou",
"value" : [ "aeiou" ],
"match_case" : "aeiou"
} ],
"version" : {
"match_criteria" : "aeiou",
"versions" : [ "aeiou" ]
},
"source_ip" : "",
"path" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_str" : [ "aeiou" ],
"match_case" : "aeiou"
},
"geo_matches" : [ {
"match_operation" : "aeiou",
"values" : [ "aeiou" ],
"attribute" : "aeiou"
} ],
"protocol" : {
"match_criteria" : "aeiou",
"protocols" : "aeiou"
},
"client_ip" : {
"group_refs" : [ "aeiou" ],
"match_criteria" : "aeiou",
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ]
},
"bot_detection_result" : {
"classifications" : [ {
"user_defined_type" : "aeiou",
"type" : "aeiou"
} ],
"match_operation" : "aeiou"
}
},
"name" : "aeiou",
"action" : "aeiou",
"index" : 123
} ]
},
"ip_location_detector" : {
"system_cloud_providers_ref" : "aeiou",
"ip_location_db_ref" : "aeiou",
"system_search_engines_ref" : "aeiou",
"enabled" : true
},
"tenant_ref" : "aeiou",
"name" : "aeiou",
"system_consolidator_ref" : "aeiou",
"system_bot_mapping_ref" : "aeiou",
"user_bot_mapping_ref" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
BotDetectionPolicyApiResponse
401
log in failed
Up
post /botdetectionpolicy
(botdetectionpolicyPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — BotDetectionPolicy object creation
Return type
Example data
Content-Type: application/json
{
"user_consolidator_ref" : "aeiou",
"user_agent_detector" : {
"enabled" : true
},
"description" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"ip_reputation_detector" : {
"system_ip_reputation_mapping_ref" : "aeiou",
"enabled" : true,
"ip_reputation_db_ref" : "aeiou"
},
"allow_list" : {
"rules" : [ {
"condition" : {
"cookie" : {
"match_criteria" : "aeiou",
"name" : "aeiou",
"value" : "aeiou",
"match_case" : "aeiou"
},
"method" : {
"match_criteria" : "aeiou",
"methods" : [ "aeiou" ]
},
"host_hdr" : {
"match_criteria" : "aeiou",
"value" : [ "aeiou" ],
"match_case" : "aeiou"
},
"ip_reputation_type" : {
"reputation_types" : [ "aeiou" ],
"match_operation" : "aeiou"
},
"query" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_str" : [ "aeiou" ],
"match_case" : "aeiou"
},
"vs_port" : {
"match_criteria" : "aeiou",
"ports" : [ "" ]
},
"hdrs" : [ {
"match_criteria" : "aeiou",
"hdr" : "aeiou",
"value" : [ "aeiou" ],
"match_case" : "aeiou"
} ],
"version" : {
"match_criteria" : "aeiou",
"versions" : [ "aeiou" ]
},
"source_ip" : "",
"path" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_str" : [ "aeiou" ],
"match_case" : "aeiou"
},
"geo_matches" : [ {
"match_operation" : "aeiou",
"values" : [ "aeiou" ],
"attribute" : "aeiou"
} ],
"protocol" : {
"match_criteria" : "aeiou",
"protocols" : "aeiou"
},
"client_ip" : {
"group_refs" : [ "aeiou" ],
"match_criteria" : "aeiou",
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ]
},
"bot_detection_result" : {
"classifications" : [ {
"user_defined_type" : "aeiou",
"type" : "aeiou"
} ],
"match_operation" : "aeiou"
}
},
"name" : "aeiou",
"action" : "aeiou",
"index" : 123
} ]
},
"ip_location_detector" : {
"system_cloud_providers_ref" : "aeiou",
"ip_location_db_ref" : "aeiou",
"system_search_engines_ref" : "aeiou",
"enabled" : true
},
"tenant_ref" : "aeiou",
"name" : "aeiou",
"system_consolidator_ref" : "aeiou",
"system_bot_mapping_ref" : "aeiou",
"user_bot_mapping_ref" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
BotDetectionPolicy
401
log in failed
Up
delete /botdetectionpolicy/{uuid}
(botdetectionpolicyUuidDelete)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
object deleted
String
404
not found
Up
get /botdetectionpolicy/{uuid}
(botdetectionpolicyUuidGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"user_consolidator_ref" : "aeiou",
"user_agent_detector" : {
"enabled" : true
},
"description" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"ip_reputation_detector" : {
"system_ip_reputation_mapping_ref" : "aeiou",
"enabled" : true,
"ip_reputation_db_ref" : "aeiou"
},
"allow_list" : {
"rules" : [ {
"condition" : {
"cookie" : {
"match_criteria" : "aeiou",
"name" : "aeiou",
"value" : "aeiou",
"match_case" : "aeiou"
},
"method" : {
"match_criteria" : "aeiou",
"methods" : [ "aeiou" ]
},
"host_hdr" : {
"match_criteria" : "aeiou",
"value" : [ "aeiou" ],
"match_case" : "aeiou"
},
"ip_reputation_type" : {
"reputation_types" : [ "aeiou" ],
"match_operation" : "aeiou"
},
"query" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_str" : [ "aeiou" ],
"match_case" : "aeiou"
},
"vs_port" : {
"match_criteria" : "aeiou",
"ports" : [ "" ]
},
"hdrs" : [ {
"match_criteria" : "aeiou",
"hdr" : "aeiou",
"value" : [ "aeiou" ],
"match_case" : "aeiou"
} ],
"version" : {
"match_criteria" : "aeiou",
"versions" : [ "aeiou" ]
},
"source_ip" : "",
"path" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_str" : [ "aeiou" ],
"match_case" : "aeiou"
},
"geo_matches" : [ {
"match_operation" : "aeiou",
"values" : [ "aeiou" ],
"attribute" : "aeiou"
} ],
"protocol" : {
"match_criteria" : "aeiou",
"protocols" : "aeiou"
},
"client_ip" : {
"group_refs" : [ "aeiou" ],
"match_criteria" : "aeiou",
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ]
},
"bot_detection_result" : {
"classifications" : [ {
"user_defined_type" : "aeiou",
"type" : "aeiou"
} ],
"match_operation" : "aeiou"
}
},
"name" : "aeiou",
"action" : "aeiou",
"index" : 123
} ]
},
"ip_location_detector" : {
"system_cloud_providers_ref" : "aeiou",
"ip_location_db_ref" : "aeiou",
"system_search_engines_ref" : "aeiou",
"enabled" : true
},
"tenant_ref" : "aeiou",
"name" : "aeiou",
"system_consolidator_ref" : "aeiou",
"system_bot_mapping_ref" : "aeiou",
"user_bot_mapping_ref" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
BotDetectionPolicy
401
log in failed
Up
patch /botdetectionpolicy/{uuid}
(botdetectionpolicyUuidPatch)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — BotDetectionPolicy object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"user_consolidator_ref" : "aeiou",
"user_agent_detector" : {
"enabled" : true
},
"description" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"ip_reputation_detector" : {
"system_ip_reputation_mapping_ref" : "aeiou",
"enabled" : true,
"ip_reputation_db_ref" : "aeiou"
},
"allow_list" : {
"rules" : [ {
"condition" : {
"cookie" : {
"match_criteria" : "aeiou",
"name" : "aeiou",
"value" : "aeiou",
"match_case" : "aeiou"
},
"method" : {
"match_criteria" : "aeiou",
"methods" : [ "aeiou" ]
},
"host_hdr" : {
"match_criteria" : "aeiou",
"value" : [ "aeiou" ],
"match_case" : "aeiou"
},
"ip_reputation_type" : {
"reputation_types" : [ "aeiou" ],
"match_operation" : "aeiou"
},
"query" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_str" : [ "aeiou" ],
"match_case" : "aeiou"
},
"vs_port" : {
"match_criteria" : "aeiou",
"ports" : [ "" ]
},
"hdrs" : [ {
"match_criteria" : "aeiou",
"hdr" : "aeiou",
"value" : [ "aeiou" ],
"match_case" : "aeiou"
} ],
"version" : {
"match_criteria" : "aeiou",
"versions" : [ "aeiou" ]
},
"source_ip" : "",
"path" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_str" : [ "aeiou" ],
"match_case" : "aeiou"
},
"geo_matches" : [ {
"match_operation" : "aeiou",
"values" : [ "aeiou" ],
"attribute" : "aeiou"
} ],
"protocol" : {
"match_criteria" : "aeiou",
"protocols" : "aeiou"
},
"client_ip" : {
"group_refs" : [ "aeiou" ],
"match_criteria" : "aeiou",
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ]
},
"bot_detection_result" : {
"classifications" : [ {
"user_defined_type" : "aeiou",
"type" : "aeiou"
} ],
"match_operation" : "aeiou"
}
},
"name" : "aeiou",
"action" : "aeiou",
"index" : 123
} ]
},
"ip_location_detector" : {
"system_cloud_providers_ref" : "aeiou",
"ip_location_db_ref" : "aeiou",
"system_search_engines_ref" : "aeiou",
"enabled" : true
},
"tenant_ref" : "aeiou",
"name" : "aeiou",
"system_consolidator_ref" : "aeiou",
"system_bot_mapping_ref" : "aeiou",
"user_bot_mapping_ref" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
BotDetectionPolicy
401
log in failed
Up
put /botdetectionpolicy/{uuid}
(botdetectionpolicyUuidPut)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — BotDetectionPolicy object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"user_consolidator_ref" : "aeiou",
"user_agent_detector" : {
"enabled" : true
},
"description" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"ip_reputation_detector" : {
"system_ip_reputation_mapping_ref" : "aeiou",
"enabled" : true,
"ip_reputation_db_ref" : "aeiou"
},
"allow_list" : {
"rules" : [ {
"condition" : {
"cookie" : {
"match_criteria" : "aeiou",
"name" : "aeiou",
"value" : "aeiou",
"match_case" : "aeiou"
},
"method" : {
"match_criteria" : "aeiou",
"methods" : [ "aeiou" ]
},
"host_hdr" : {
"match_criteria" : "aeiou",
"value" : [ "aeiou" ],
"match_case" : "aeiou"
},
"ip_reputation_type" : {
"reputation_types" : [ "aeiou" ],
"match_operation" : "aeiou"
},
"query" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_str" : [ "aeiou" ],
"match_case" : "aeiou"
},
"vs_port" : {
"match_criteria" : "aeiou",
"ports" : [ "" ]
},
"hdrs" : [ {
"match_criteria" : "aeiou",
"hdr" : "aeiou",
"value" : [ "aeiou" ],
"match_case" : "aeiou"
} ],
"version" : {
"match_criteria" : "aeiou",
"versions" : [ "aeiou" ]
},
"source_ip" : "",
"path" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_str" : [ "aeiou" ],
"match_case" : "aeiou"
},
"geo_matches" : [ {
"match_operation" : "aeiou",
"values" : [ "aeiou" ],
"attribute" : "aeiou"
} ],
"protocol" : {
"match_criteria" : "aeiou",
"protocols" : "aeiou"
},
"client_ip" : {
"group_refs" : [ "aeiou" ],
"match_criteria" : "aeiou",
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ]
},
"bot_detection_result" : {
"classifications" : [ {
"user_defined_type" : "aeiou",
"type" : "aeiou"
} ],
"match_operation" : "aeiou"
}
},
"name" : "aeiou",
"action" : "aeiou",
"index" : 123
} ]
},
"ip_location_detector" : {
"system_cloud_providers_ref" : "aeiou",
"ip_location_db_ref" : "aeiou",
"system_search_engines_ref" : "aeiou",
"enabled" : true
},
"tenant_ref" : "aeiou",
"name" : "aeiou",
"system_consolidator_ref" : "aeiou",
"system_bot_mapping_ref" : "aeiou",
"user_bot_mapping_ref" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
BotDetectionPolicy
401
log in failed
[ Jump to Methods ]
Table of Contents
BotAllowListBotAllowRuleBotClassificationBotConfigIPLocationBotConfigIPReputationBotConfigUserAgentBotDetectionMatchBotDetectionPolicyBotDetectionPolicyApiResponseCookieMatchGeoMatchHTTPVersionMatchHdrMatchHostHdrMatchIPReputationTypeMatchIpAddrIpAddrMatchIpAddrPrefixIpAddrRangeMatchTargetMethodMatchPathMatchPortMatchProtocolMatchQueryMatch
rules (optional)
array[BotAllowRule] Allow rules to control which requests undergo BOT detection. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
action
String The action to take. Enum options - BOT_ACTION_BYPASS, BOT_ACTION_CONTINUE. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
condition
MatchTarget The condition to match. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
index
Integer Rules are processed in order of this index field. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
name (optional)
String A name describing the rule in a short form. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
type
String One of the system-defined Bot classification types. Enum options - HUMAN, GOOD_BOT, BAD_BOT, DANGEROUS_BOT, USER_DEFINED_BOT, UNKNOWN_CLIENT. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
user_defined_type (optional)
String If 'type' has BotClassificationTypes value 'USER_DEFINED', this is the user-defined value. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
enabled (optional)
Boolean If this is enabled, IP location information is used to determine if a client is a known search engine bot, comes from the cloud, etc. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ip_location_db_ref (optional)
String The UUID of the Geo-IP database to use. It is a reference to an object of type GeoDB. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
system_cloud_providers_ref (optional)
String The system-defined cloud providers. It is a reference to an object of type StringGroup. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
system_search_engines_ref (optional)
String The system-defined search engines. It is a reference to an object of type StringGroup. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
enabled (optional)
Boolean Whether IP reputation-based Bot detection is enabled. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ip_reputation_db_ref (optional)
String The UUID of the IP reputation DB to use. It is a reference to an object of type IPReputationDB. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
system_ip_reputation_mapping_ref (optional)
String The system-provided mapping from IP reputation types to Bot types. It is a reference to an object of type BotIPReputationTypeMapping. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
enabled (optional)
Boolean Whether User Agent-based Bot detection is enabled. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
classifications (optional)
array[BotClassification] Bot classification types. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
match_operation
String Match criteria. Enum options - IS_IN, IS_NOT_IN. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
allow_list (optional)
BotAllowList Allow the user to skip BotManagement for selected requests. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
description (optional)
String Human-readable description of this Bot Detection Policy. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ip_location_detector
BotConfigIPLocation The IP location configuration used in this policy. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ip_reputation_detector
BotConfigIPReputation The IP reputation configuration used in this policy. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
name
String The name of this Bot Detection Policy. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
system_bot_mapping_ref (optional)
String System-defined rules for classification. It is a reference to an object of type BotMapping. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
system_consolidator_ref (optional)
String The installation provides an updated ruleset for consolidating the results of different decider phases. It is a reference to an object of type BotConfigConsolidator. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
tenant_ref (optional)
String The unique identifier of the tenant to which this policy belongs. It is a reference to an object of type Tenant. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
url (optional)
user_agent_detector
BotConfigUserAgent The User-Agent configuration used in this policy. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
user_bot_mapping_ref (optional)
String User-defined rules for classification. These are applied before the system classification rules. If a rule matches, processing terminates and the system-defined rules will not run. It is a reference to an object of type BotMapping. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
user_consolidator_ref (optional)
String The user-provided ruleset for consolidating the results of different decider phases. This runs before the system consolidator. If it successfully sets a consolidation, the system consolidator will not change it. It is a reference to an object of type BotConfigConsolidator. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
uuid (optional)
String A unique identifier to this Bot Detection Policy. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
count
results
next (optional)
match_case (optional)
String Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
match_criteria
String Criterion to use for matching the cookie in the HTTP request. Enum options - HDR_EXISTS, HDR_DOES_NOT_EXIST, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH, HDR_CONTAINS, HDR_DOES_NOT_CONTAIN, HDR_ENDS_WITH, HDR_DOES_NOT_END_WITH, HDR_EQUALS, HDR_DOES_NOT_EQUAL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
name
String Name of the cookie. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
String String value in the cookie. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
attribute
String The Geo data type to match on. Enum options - ATTRIBUTE_IP_PREFIX, ATTRIBUTE_COUNTRY_CODE, ATTRIBUTE_COUNTRY_NAME, ATTRIBUTE_CONTINENT_CODE, ATTRIBUTE_CONTINENT_NAME, ATTRIBUTE_REGION_NAME, ATTRIBUTE_CITY_NAME, ATTRIBUTE_ISP_NAME, ATTRIBUTE_ORGANIZATION_NAME, ATTRIBUTE_AS_NUMBER, ATTRIBUTE_AS_NAME, ATTRIBUTE_LONGITUDE, ATTRIBUTE_LATITUDE, ATTRIBUTE_CUSTOM_1, ATTRIBUTE_CUSTOM_2, ATTRIBUTE_CUSTOM_3, ATTRIBUTE_CUSTOM_4, ATTRIBUTE_CUSTOM_5, ATTRIBUTE_CUSTOM_6, ATTRIBUTE_CUSTOM_7, ATTRIBUTE_CUSTOM_8, ATTRIBUTE_CUSTOM_9, ATTRIBUTE_USER_DEFINED_MAPPING. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
match_operation
String Match criteria. Enum options - IS_IN, IS_NOT_IN. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
values
array[String] The values to match. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
match_criteria
String Criterion to use for HTTP version matching the version used in the HTTP request. Enum options - IS_IN, IS_NOT_IN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
versions (optional)
array[String] HTTP protocol version. Enum options - ZERO_NINE, ONE_ZERO, ONE_ONE, TWO_ZERO. Minimum of 1 items required. Maximum of 8 items allowed. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- ONE_ZERO,ONE_ONE), Basic edition(Allowed values- ONE_ZERO,ONE_ONE), Enterprise with Cloud Services edition.
hdr
String Name of the HTTP header whose value is to be matched. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
match_case (optional)
String Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
match_criteria
String Criterion to use for matching headers in the HTTP request. Enum options - HDR_EXISTS, HDR_DOES_NOT_EXIST, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH, HDR_CONTAINS, HDR_DOES_NOT_CONTAIN, HDR_ENDS_WITH, HDR_DOES_NOT_END_WITH, HDR_EQUALS, HDR_DOES_NOT_EQUAL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
array[String] String values to match in the HTTP header. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
match_case (optional)
String Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
match_criteria
String Criterion to use for the host header value match. Enum options - HDR_EXISTS, HDR_DOES_NOT_EXIST, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH, HDR_CONTAINS, HDR_DOES_NOT_CONTAIN, HDR_ENDS_WITH, HDR_DOES_NOT_END_WITH, HDR_EQUALS, HDR_DOES_NOT_EQUAL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
array[String] String value(s) in the host header. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
match_operation
String Match criteria. Enum options - IS_IN, IS_NOT_IN. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reputation_types (optional)
array[String] IP reputation type. Enum options - IP_REPUTATION_TYPE_SPAM_SOURCE, IP_REPUTATION_TYPE_WINDOWS_EXPLOITS, IP_REPUTATION_TYPE_WEB_ATTACKS, IP_REPUTATION_TYPE_BOTNETS, IP_REPUTATION_TYPE_SCANNERS, IP_REPUTATION_TYPE_DOS, IP_REPUTATION_TYPE_REPUTATION, IP_REPUTATION_TYPE_PHISHING, IP_REPUTATION_TYPE_PROXY, IP_REPUTATION_TYPE_NETWORK, IP_REPUTATION_TYPE_CLOUD, IP_REPUTATION_TYPE_MOBILE_THREATS, IP_REPUTATION_TYPE_TOR, IP_REPUTATION_TYPE_ALL. Field introduced in 20.1.1. Minimum of 1 items required. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
addr
String IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
type
String Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
addrs (optional)
array[IpAddr] IP address(es). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
group_refs (optional)
array[String] UUID of IP address group(s). It is a reference to an object of type IpAddrGroup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
match_criteria
String Criterion to use for IP address matching the HTTP request. Enum options - IS_IN, IS_NOT_IN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
prefixes (optional)
array[IpAddrPrefix] IP address prefix(es). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ranges (optional)
array[IpAddrRange] IP address range(s). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ip_addr
IpAddr Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mask
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
begin
IpAddr Starting IP address of the range. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
end
IpAddr Ending IP address of the range. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
bot_detection_result (optional)
BotDetectionMatch Configure the bot classification result. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
client_ip (optional)
IpAddrMatch Configure client ip addresses. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
cookie (optional)
CookieMatch Configure HTTP cookie(s). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
geo_matches (optional)
array[GeoMatch] Configure the geo information. Field introduced in 21.1.1. Maximum of 1 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
hdrs (optional)
array[HdrMatch] Configure HTTP header(s). All configured headers must match. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
host_hdr (optional)
HostHdrMatch Configure the host header. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ip_reputation_type (optional)
IPReputationTypeMatch Configure IP reputation. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
method (optional)
MethodMatch Configure HTTP methods. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
path (optional)
PathMatch Configure request paths. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
protocol (optional)
ProtocolMatch Configure the type of HTTP protocol. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
query (optional)
QueryMatch Configure request query. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
source_ip (optional)
IpAddrMatch Configure source ip addresses. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
version (optional)
HTTPVersionMatch Configure versions of the HTTP protocol. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vs_port (optional)
PortMatch Configure virtual service ports. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
match_criteria
String Criterion to use for HTTP method matching the method in the HTTP request. Enum options - IS_IN, IS_NOT_IN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
methods (optional)
array[String] Configure HTTP method(s). Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK. Minimum of 1 items required. Maximum of 16 items allowed. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- HTTP_METHOD_GET,HTTP_METHOD_PUT,HTTP_METHOD_POST,HTTP_METHOD_HEAD,HTTP_METHOD_OPTIONS), Basic edition(Allowed values- HTTP_METHOD_GET,HTTP_METHOD_PUT,HTTP_METHOD_POST,HTTP_METHOD_HEAD,HTTP_METHOD_OPTIONS), Enterprise with Cloud Services edition.
match_case (optional)
String Case sensitivity to use for the matching. Enum options - SENSITIVE, INSENSITIVE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
match_criteria
String Criterion to use for matching the path in the HTTP request URI. Enum options - BEGINS_WITH, DOES_NOT_BEGIN_WITH, CONTAINS, DOES_NOT_CONTAIN, ENDS_WITH, DOES_NOT_END_WITH, EQUALS, DOES_NOT_EQUAL, REGEX_MATCH, REGEX_DOES_NOT_MATCH. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL), Basic edition(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL), Enterprise with Cloud Services edition.
match_str (optional)
array[String] String values. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
string_group_refs (optional)
array[String] UUID of the string group(s). It is a reference to an object of type StringGroup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
match_criteria
String Criterion to use for port matching the HTTP request. Enum options - IS_IN, IS_NOT_IN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ports (optional)
array[Integer] Listening TCP port(s). Allowed values are 1-65535. Minimum of 1 items required. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
match_criteria
String Criterion to use for protocol matching the HTTP request. Enum options - IS_IN, IS_NOT_IN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
protocols
String HTTP or HTTPS protocol. Enum options - HTTP, HTTPS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
match_case (optional)
String Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
match_criteria
String Criterion to use for matching the query in HTTP request URI. Enum options - QUERY_MATCH_CONTAINS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
match_str (optional)
array[String] String value(s). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
string_group_refs (optional)
array[String] UUID of the string group(s). It is a reference to an object of type StringGroup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.