Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

botpolicy

August 17, 2023
Contributed by: 
C

Statistics for Bot policy resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
name Read-write Name of the bot policy for which to show detailed statistics.

Minimum length = 1
clearstats Read-write Clear the statsistics / counters.

Possible values = basic, full
pipolicyhits Read-only Number of hits on the policy
pipolicyhitsrate Read-only Rate (/s) counter for pipolicyhits
pipolicyundefhits Read-only Number of undef hits on the policy
pipolicyundefhitsrate Read-only Rate (/s) counter for pipolicyundefhits

Operations

(click to see Properties )

  • GET (ALL)
  • GET

Some options that you can use for each operations:

  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.

  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER: <username>

    X-NITRO-PASS: <password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

*Note: *

Mandatory parameters are marked in red and placeholder content is marked in green

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/stat/botpolicy

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/stat/botpolicy? args=name: <String_value> ,detail: <Boolean_value> ,fullvalues: <Boolean_value> ,ntimes: <Double_value> ,logfile: <String_value> ,clearstats: <String_value>

Use this query-parameter to get botpolicy resources based on additional properties.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload: 


{  "botpolicy": [ {
      "name":<String_value>,
      "pipolicyundefhitsrate":<Double_value>,
      "pipolicyundefhits":<Double_value>,
      "pipolicyhitsrate":<Double_value>,
      "pipolicyhits":<Double_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/stat/botpolicy/ name_value><String>

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload: 


{  "botpolicy": [ {
      "name":<String_value>,
      "pipolicyundefhitsrate":<Double_value>,
      "pipolicyundefhits":<Double_value>,
      "pipolicyhitsrate":<Double_value>,
      "pipolicyhits":<Double_value>
}]}

<!--NeedCopy-->
botpolicy
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.