Skip to content

bot

Statistics for bot.

Properties

(click to see Operations )

Name Data Type Permissions Description
clearstats <String> Read-write Clear the statsistics / counters.

Possible values = basic, full
botrequests <Double> Read-only HTTP/HTTPS requests sent to your protected web servers via the Bot Management.
botrequestsrate <Double> Read-only Rate (/s) counter for botrequests
botreqbytes <Double> Read-only Number of bytes transfered for requests
botreqbytesrate <Double> Read-only Rate (/s) counter for botreqbytes
botresponses <Double> Read-only HTTP/HTTPS responses sent by your protected web servers via the Bot Management.
botresponsesrate <Double> Read-only Rate (/s) counter for botresponses
botresbytes <Double> Read-only Number of bytes transfered for responses
botresbytesrate <Double> Read-only Rate (/s) counter for botresbytes
botvioldevicefingerprint <Double> Read-only Number of device fingerprint violations seen by the Bot Management.
botvioldevicefingerprintrate <Double> Read-only Rate (/s) counter for botvioldevicefingerprint
botvioldevicefingerprintlog <Double> Read-only Number of device fingerprint violations logged by the Bot Management.
botvioldevicefingerprintlograte <Double> Read-only Rate (/s) counter for botvioldevicefingerprintlog
botvioldevicefingerprintdrop <Double> Read-only Number of device fingerprint violations dropped by the Bot Management.
botvioldevicefingerprintdroprate <Double> Read-only Rate (/s) counter for botvioldevicefingerprintdrop
botvioldevicefingerprintredirect <Double> Read-only Number of device fingerprint violations requests redirected by the Bot Management to a different Web page or web server.
botvioldevicefingerprintredirectrate <Double> Read-only Rate (/s) counter for botvioldevicefingerprintredirect
botviolipreputation <Double> Read-only Number of ip reputation violations seen by the Bot Management.
botviolipreputationrate <Double> Read-only Rate (/s) counter for botviolipreputation
botviolipreputationlog <Double> Read-only Number of ip reputation violations logged by the Bot Management.
botviolipreputationlograte <Double> Read-only Rate (/s) counter for botviolipreputationlog
botviolipreputationdrop <Double> Read-only Number of ip reputation violations dropped by the Bot Management.
botviolipreputationdroprate <Double> Read-only Rate (/s) counter for botviolipreputationdrop
botviolipreputationredirect <Double> Read-only Number of ip reputation violations requests redirected by the Bot Management to a different Web page or web server.
botviolipreputationredirectrate <Double> Read-only Rate (/s) counter for botviolipreputationredirect
botviolwhitelist <Double> Read-only Number of white list violations seen by the Bot Management.
botviolwhitelistrate <Double> Read-only Rate (/s) counter for botviolwhitelist
botviolwhitelistlog <Double> Read-only Number of white list violations logged by the Bot Management.
botviolwhitelistlograte <Double> Read-only Rate (/s) counter for botviolwhitelistlog
botviolblacklist <Double> Read-only Number of black list violations seen by the Bot Management.
botviolblacklistrate <Double> Read-only Rate (/s) counter for botviolblacklist
botviolblacklistlog <Double> Read-only Number of black list violations logged by the Bot Management.
botviolblacklistlograte <Double> Read-only Rate (/s) counter for botviolblacklistlog
botviolblacklistdrop <Double> Read-only Number of black list violations dropped by the Bot Management.
botviolblacklistdroprate <Double> Read-only Rate (/s) counter for botviolblacklistdrop
botviolblacklistredirect <Double> Read-only Number of black list violations redirected by the Bot Management to a different Web page or web server.
botviolblacklistredirectrate <Double> Read-only Rate (/s) counter for botviolblacklistredirect
botviolratelimit <Double> Read-only Number of rate limiting violations seen by the Bot Management.
botviolratelimitrate <Double> Read-only Rate (/s) counter for botviolratelimit
botviolratelimitlog <Double> Read-only Number of rate limiting violations logged by the Bot Management.
botviolratelimitlograte <Double> Read-only Rate (/s) counter for botviolratelimitlog
botviolratelimitdrop <Double> Read-only Number of rate limiting violations dropped by the Bot Management.
botviolratelimitdroprate <Double> Read-only Rate (/s) counter for botviolratelimitdrop
botviolratelimitredirect <Double> Read-only Number of rate limiting violations requests redirected by the Bot Management to a different Web page or web server.
botviolratelimitredirectrate <Double> Read-only Rate (/s) counter for botviolratelimitredirect
botviolstaticsignature <Double> Read-only Number of static signature violations seen by the Bot Management.
botviolstaticsignaturerate <Double> Read-only Rate (/s) counter for botviolstaticsignature
botviolstaticsignaturelog <Double> Read-only Number of static signature violations logged by the Bot Management.
botviolstaticsignaturelograte <Double> Read-only Rate (/s) counter for botviolstaticsignaturelog
botviolstaticsignaturedrop <Double> Read-only Number of static signature violations dropped by the Bot Management.
botviolstaticsignaturedroprate <Double> Read-only Rate (/s) counter for botviolstaticsignaturedrop
botviolstaticsignatureredirect <Double> Read-only Number of static signature violations requests redirected by the Bot Management to a different Web page or web server.
botviolstaticsignatureredirectrate <Double> Read-only Rate (/s) counter for botviolstaticsignatureredirect

Operations

(click to see Properties )

  • GET (ALL)

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/bot

Query-parameters:

args

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

Use this query-parameter to get bot 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:

{  "bot": [ {
      "botviolstaticsignaturedrop":<Double_value>,
      "botviolblacklistrate":<Double_value>,
      "botviolratelimitlog":<Double_value>,
      "botviolblacklist":<Double_value>,
      "botrequestsrate":<Double_value>,
      "botresponsesrate":<Double_value>,
      "botvioldevicefingerprintlog":<Double_value>,
      "botviolstaticsignatureredirectrate":<Double_value>,
      "botviolipreputationlograte":<Double_value>,
      "botviolipreputationredirectrate":<Double_value>,
      "botviolratelimitredirectrate":<Double_value>,
      "botvioldevicefingerprintdroprate":<Double_value>,
      "botviolwhitelistlograte":<Double_value>,
      "botviolipreputationdroprate":<Double_value>,
      "botviolratelimitdroprate":<Double_value>,
      "botresbytesrate":<Double_value>,
      "botviolratelimitrate":<Double_value>,
      "botviolblacklistdrop":<Double_value>,
      "botreqbytesrate":<Double_value>,
      "botviolipreputationlog":<Double_value>,
      "botvioldevicefingerprintdrop":<Double_value>,
      "botresbytes":<Double_value>,
      "botviolipreputationredirect":<Double_value>,
      "botviolratelimit":<Double_value>,
      "botreqbytes":<Double_value>,
      "botviolblacklistdroprate":<Double_value>,
      "botviolwhitelistrate":<Double_value>,
      "botviolstaticsignaturelograte":<Double_value>,
      "botviolstaticsignaturerate":<Double_value>,
      "botviolipreputation":<Double_value>,
      "botviolwhitelist":<Double_value>,
      "botviolblacklistlograte":<Double_value>,
      "botviolipreputationdrop":<Double_value>,
      "botviolratelimitdrop":<Double_value>,
      "botviolblacklistredirect":<Double_value>,
      "botvioldevicefingerprint":<Double_value>,
      "botviolratelimitredirect":<Double_value>,
      "botviolblacklistredirectrate":<Double_value>,
      "botviolstaticsignaturedroprate":<Double_value>,
      "botviolipreputationrate":<Double_value>,
      "botvioldevicefingerprintredirect":<Double_value>,
      "botviolstaticsignatureredirect":<Double_value>,
      "botviolwhitelistlog":<Double_value>,
      "botvioldevicefingerprintrate":<Double_value>,
      "botrequests":<Double_value>,
      "botviolstaticsignaturelog":<Double_value>,
      "botviolstaticsignature":<Double_value>,
      "botviolblacklistlog":<Double_value>,
      "botvioldevicefingerprintredirectrate":<Double_value>,
      "botvioldevicefingerprintlograte":<Double_value>,
      "botresponses":<Double_value>,
      "botviolratelimitlograte":<Double_value>
}]}