Avi BotMapping Object API
CLI ``` - configure botmapping - show botmapping ```
Version: 22.1.5
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /botmappingpost /botmappingdelete /botmapping/{uuid}get /botmapping/{uuid}patch /botmapping/{uuid}put /botmapping/{uuid}
(botmappingGet)
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" : [ {
"mapping_rules" : [ {
"match" : {
"path" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_decoded_string" : true,
"match_str" : [ "aeiou" ],
"match_case" : "aeiou"
},
"component_matcher" : "aeiou",
"identifier_matcher" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_str" : [ "aeiou" ]
},
"method" : {
"match_criteria" : "aeiou",
"methods" : [ "aeiou" ]
},
"class_matcher" : {
"op" : "aeiou",
"client_classes" : [ "aeiou" ]
},
"host_hdr" : {
"match_criteria" : "aeiou",
"value" : [ "aeiou" ],
"match_case" : "aeiou"
},
"client_ip" : {
"group_refs" : [ "aeiou" ],
"match_criteria" : "aeiou",
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ]
},
"type_matcher" : {
"op" : "aeiou",
"client_types" : [ "aeiou" ]
},
"hdrs" : [ {
"match_criteria" : "aeiou",
"hdr" : "aeiou",
"value" : [ "aeiou" ],
"match_case" : "aeiou"
} ]
},
"name" : "aeiou",
"index" : 123,
"classification" : {
"user_defined_type" : "aeiou",
"type" : "aeiou"
}
} ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
BotMappingApiResponse
401
log in failed
(botmappingPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — BotMapping object creation
Return type
Example data
Content-Type: application/json
{
"mapping_rules" : [ {
"match" : {
"path" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_decoded_string" : true,
"match_str" : [ "aeiou" ],
"match_case" : "aeiou"
},
"component_matcher" : "aeiou",
"identifier_matcher" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_str" : [ "aeiou" ]
},
"method" : {
"match_criteria" : "aeiou",
"methods" : [ "aeiou" ]
},
"class_matcher" : {
"op" : "aeiou",
"client_classes" : [ "aeiou" ]
},
"host_hdr" : {
"match_criteria" : "aeiou",
"value" : [ "aeiou" ],
"match_case" : "aeiou"
},
"client_ip" : {
"group_refs" : [ "aeiou" ],
"match_criteria" : "aeiou",
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ]
},
"type_matcher" : {
"op" : "aeiou",
"client_types" : [ "aeiou" ]
},
"hdrs" : [ {
"match_criteria" : "aeiou",
"hdr" : "aeiou",
"value" : [ "aeiou" ],
"match_case" : "aeiou"
} ]
},
"name" : "aeiou",
"index" : 123,
"classification" : {
"user_defined_type" : "aeiou",
"type" : "aeiou"
}
} ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
BotMapping
401
log in failed
Up
delete /botmapping/{uuid}
(botmappingUuidDelete)
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 /botmapping/{uuid}
(botmappingUuidGet)
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
{
"mapping_rules" : [ {
"match" : {
"path" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_decoded_string" : true,
"match_str" : [ "aeiou" ],
"match_case" : "aeiou"
},
"component_matcher" : "aeiou",
"identifier_matcher" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_str" : [ "aeiou" ]
},
"method" : {
"match_criteria" : "aeiou",
"methods" : [ "aeiou" ]
},
"class_matcher" : {
"op" : "aeiou",
"client_classes" : [ "aeiou" ]
},
"host_hdr" : {
"match_criteria" : "aeiou",
"value" : [ "aeiou" ],
"match_case" : "aeiou"
},
"client_ip" : {
"group_refs" : [ "aeiou" ],
"match_criteria" : "aeiou",
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ]
},
"type_matcher" : {
"op" : "aeiou",
"client_types" : [ "aeiou" ]
},
"hdrs" : [ {
"match_criteria" : "aeiou",
"hdr" : "aeiou",
"value" : [ "aeiou" ],
"match_case" : "aeiou"
} ]
},
"name" : "aeiou",
"index" : 123,
"classification" : {
"user_defined_type" : "aeiou",
"type" : "aeiou"
}
} ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
BotMapping
401
log in failed
Up
patch /botmapping/{uuid}
(botmappingUuidPatch)
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 — BotMapping object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"mapping_rules" : [ {
"match" : {
"path" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_decoded_string" : true,
"match_str" : [ "aeiou" ],
"match_case" : "aeiou"
},
"component_matcher" : "aeiou",
"identifier_matcher" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_str" : [ "aeiou" ]
},
"method" : {
"match_criteria" : "aeiou",
"methods" : [ "aeiou" ]
},
"class_matcher" : {
"op" : "aeiou",
"client_classes" : [ "aeiou" ]
},
"host_hdr" : {
"match_criteria" : "aeiou",
"value" : [ "aeiou" ],
"match_case" : "aeiou"
},
"client_ip" : {
"group_refs" : [ "aeiou" ],
"match_criteria" : "aeiou",
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ]
},
"type_matcher" : {
"op" : "aeiou",
"client_types" : [ "aeiou" ]
},
"hdrs" : [ {
"match_criteria" : "aeiou",
"hdr" : "aeiou",
"value" : [ "aeiou" ],
"match_case" : "aeiou"
} ]
},
"name" : "aeiou",
"index" : 123,
"classification" : {
"user_defined_type" : "aeiou",
"type" : "aeiou"
}
} ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
BotMapping
401
log in failed
Up
put /botmapping/{uuid}
(botmappingUuidPut)
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 — BotMapping object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"mapping_rules" : [ {
"match" : {
"path" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_decoded_string" : true,
"match_str" : [ "aeiou" ],
"match_case" : "aeiou"
},
"component_matcher" : "aeiou",
"identifier_matcher" : {
"match_criteria" : "aeiou",
"string_group_refs" : [ "aeiou" ],
"match_str" : [ "aeiou" ]
},
"method" : {
"match_criteria" : "aeiou",
"methods" : [ "aeiou" ]
},
"class_matcher" : {
"op" : "aeiou",
"client_classes" : [ "aeiou" ]
},
"host_hdr" : {
"match_criteria" : "aeiou",
"value" : [ "aeiou" ],
"match_case" : "aeiou"
},
"client_ip" : {
"group_refs" : [ "aeiou" ],
"match_criteria" : "aeiou",
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ]
},
"type_matcher" : {
"op" : "aeiou",
"client_types" : [ "aeiou" ]
},
"hdrs" : [ {
"match_criteria" : "aeiou",
"hdr" : "aeiou",
"value" : [ "aeiou" ],
"match_case" : "aeiou"
} ]
},
"name" : "aeiou",
"index" : 123,
"classification" : {
"user_defined_type" : "aeiou",
"type" : "aeiou"
}
} ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
BotMapping
401
log in failed
[ Jump to Methods ]
Table of Contents
BotClassMatcherBotClassificationBotMappingBotMappingApiResponseBotMappingRuleBotMappingRuleMatchTargetBotTypeMatcherHdrMatchHostHdrMatchIpAddrIpAddrMatchIpAddrPrefixIpAddrRangeMethodMatchPathMatchStringMatch
client_classes (optional)
array[String] The list of client classes. Enum options - UNDETERMINED_CLIENT, HUMAN_CLIENT, BOT_CLIENT. Field introduced in 21.1.1. Minimum of 1 items required. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
op (optional)
String The match operation. 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.
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.
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
mapping_rules (optional)
array[BotMappingRule] Rules for bot classification. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
name
String The name of this mapping. 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 mapping 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)
uuid (optional)
String A unique identifier for this mapping. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
count
results
next (optional)
classification
BotClassification The assigned classification for this client. 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
match
BotMappingRuleMatchTarget How to match the request all the specified properties must be fulfilled. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
name
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.
class_matcher (optional)
BotClassMatcher How to match the BotClientClass. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
client_ip (optional)
IpAddrMatch Configure client ip addresses. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
component_matcher (optional)
String The component for which this mapping is used. Enum options - BOT_DECIDER_CONSOLIDATION, BOT_DECIDER_USER_AGENT, BOT_DECIDER_IP_REPUTATION, BOT_DECIDER_IP_NETWORK_LOCATION. Field introduced in 21.1.3. 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. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
host_hdr (optional)
HostHdrMatch Configure the host header. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
identifier_matcher (optional)
StringMatch The list of bot identifier names and how they're matched. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
method (optional)
MethodMatch Configure HTTP methods. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
path (optional)
PathMatch Configure request paths. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
type_matcher (optional)
BotTypeMatcher How to match the BotClientType. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
client_types (optional)
array[String] The list of client types. Enum options - UNDETERMINED_CLIENT_TYPE, WEB_BROWSER, IN_APP_BROWSER, SEARCH_ENGINE, IMPERSONATOR, SPAM_SOURCE, WEB_ATTACKS, BOTNET, SCANNER, DENIAL_OF_SERVICE, CLOUD_SOURCE, SECURITY_SCANNER, SITE_MONITOR, GENERIC_APPLICATION, SUSPICIOUS_APPLICATION. Field introduced in 21.1.1. Minimum of 1 items required. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
op (optional)
String The match operation. 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.
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.
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.
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_decoded_string (optional)
Boolean Match against the decoded URI path. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, 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 string matching the HTTP request. 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 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.