getbotpolicyResult Structure Definition

The getbotpolicyResult structure defines the return type for getbotpolicy API.

Syntax



Members

rc

If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings.

message

If the method succeeds, message is NULL else message contains Error/Warning message.

botpolicyList

List of botpolicys


botpolicy Structure Definition

The botpolicy structure defines the actual return type values for getbotpolicy API.

Syntax



Members

name

Name of the bot policy for which to display settings.

rule

Expression that the policy uses to determine whether to apply bot profile on the specified request.

profilename

Name of the bot profile to apply if the request matches this bot policy.

undefaction

Action to perform if the result of policy evaluation is undefined (UNDEF). An UNDEF event indicates an internal error condition.

hits

Number of hits.

undefhits

Number of policy UNDEF hits.

activepolicy

Indicates whether policy is bound or not.

boundto

Location where policy is bound

priority

Specifies the priority of the policy.

gotopriorityexpression

Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.

labeltype

Type of policy label invocation.

labelname

Name of the label to invoke if the current policy rule evaluates to TRUE.

comment

Any type of information about this bot policy.

logaction

Name of the messagelog action to use for requests that match this policy.

builtin

Flag to determine if bot policy is built-in or not

_nextgenapiresource


See Also