ADC NITRO APIs
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 |
| botvioldevicefingerprintcaptcha | <Double> | Read-only | Number of device fingerprint violations requests for which CAPTCHA challenge was sent. |
| botvioldevicefingerprintcaptcharate | <Double> | Read-only | Rate (/s) counter for botvioldevicefingerprintcaptcha |
| botvioldevicefingerprintreset | <Double> | Read-only | Number of device fingerprint violations reset by the Bot Management. |
| botvioldevicefingerprintresetrate | <Double> | Read-only | Rate (/s) counter for botvioldevicefingerprintreset |
| 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 |
| botviolipreputationcaptcha | <Double> | Read-only | Number of ip reputation violations requests for which CAPTCHA challenge was sent. |
| botviolipreputationcaptcharate | <Double> | Read-only | Rate (/s) counter for botviolipreputationcaptcha |
| botviolipreputationreset | <Double> | Read-only | Number of ip reputation violations reset by the Bot Management. |
| botviolipreputationresetrate | <Double> | Read-only | Rate (/s) counter for botviolipreputationreset |
| 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 |
| botviolblacklistreset | <Double> | Read-only | Number of black list violations reset by the Bot Management. |
| botviolblacklistresetrate | <Double> | Read-only | Rate (/s) counter for botviolblacklistreset |
| 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 |
| botviolratelimitreset | <Double> | Read-only | Number of rate limiting violations reset by the Bot Management. |
| botviolratelimitresetrate | <Double> | Read-only | Rate (/s) counter for botviolratelimitreset |
| 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 |
| botviolstaticsignaturereset | <Double> | Read-only | Number of static signature violations requests reset by the Bot Management to a different Web page or web server. |
| botviolstaticsignatureresetrate | <Double> | Read-only | Rate (/s) counter for botviolstaticsignaturereset |
| botvioltps | <Double> | Read-only | Number of tps violations seen by the Bot Management. |
| botvioltpsrate | <Double> | Read-only | Rate (/s) counter for botvioltps |
| botvioltpslog | <Double> | Read-only | Number of tps violations logged by the Bot Management. |
| botvioltpslograte | <Double> | Read-only | Rate (/s) counter for botvioltpslog |
| botvioltpsdrop | <Double> | Read-only | Number of tps violations dropped by the Bot Management. |
| botvioltpsdroprate | <Double> | Read-only | Rate (/s) counter for botvioltpsdrop |
| botvioltpsredirect | <Double> | Read-only | Number of tps violations requests redirected by the Bot Management to a different Web page or web server. |
| botvioltpsredirectrate | <Double> | Read-only | Rate (/s) counter for botvioltpsredirect |
| botvioltpsreset | <Double> | Read-only | Number of tps violations reset by the Bot Management. |
| botvioltpsresetrate | <Double> | Read-only | Rate (/s) counter for botvioltpsreset |
| botvioltpscaptcha | <Double> | Read-only | Number of TPS violations requests for which CAPTCHA challenge was sent. |
| botvioltpscaptcharate | <Double> | Read-only | Rate (/s) counter for botvioltpscaptcha |
| botviolcaptcha | <Double> | Read-only | Number of Captcha challenge failures seen by the Bot Management. |
| botviolcaptcharate | <Double> | Read-only | Rate (/s) counter for botviolcaptcha |
| botviolcaptchalog | <Double> | Read-only | Number of Captcha challenge failures logged by the Bot Management. |
| botviolcaptchalograte | <Double> | Read-only | Rate (/s) counter for botviolcaptchalog |
| botviolcaptchadrop | <Double> | Read-only | Number of Captcha challenge failures dropped by the Bot Management. |
| botviolcaptchadroprate | <Double> | Read-only | Rate (/s) counter for botviolcaptchadrop |
| botviolcaptcharedirect | <Double> | Read-only | Number of Captcha challenge failures redirected by the Bot Management. |
| botviolcaptcharedirectrate | <Double> | Read-only | Rate (/s) counter for botviolcaptcharedirect |
| botviolcaptchareset | <Double> | Read-only | Number of Captcha challenge failures reset by the Bot Management. |
| botviolcaptcharesetrate | <Double> | Read-only | Rate (/s) counter for botviolcaptchareset |
| botvioltrap | <Double> | Read-only | Number of trap violations seen by the Bot Management. |
| botvioltraprate | <Double> | Read-only | Rate (/s) counter for botvioltrap |
| botvioltraplog | <Double> | Read-only | Number of trap violations logged by the Bot Management. |
| botvioltraplograte | <Double> | Read-only | Rate (/s) counter for botvioltraplog |
| botvioltrapdrop | <Double> | Read-only | Number of trap violations dropped by the Bot Management. |
| botvioltrapdroprate | <Double> | Read-only | Rate (/s) counter for botvioltrapdrop |
| botvioltrapredirect | <Double> | Read-only | Number of trap violations requests redirected by the Bot Management to a different Web page or web server. |
| botvioltrapredirectrate | <Double> | Read-only | Rate (/s) counter for botvioltrapredirect |
| botvioltrapreset | <Double> | Read-only | Number of trap violations reset by the Bot Management. |
| botvioltrapresetrate | <Double> | Read-only | Rate (/s) counter for botvioltrapreset |
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": [ {
"botviolipreputationlograte":<Double_value>,
"botviolstaticsignaturereset":<Double_value>,
"botvioltps":<Double_value>,
"botvioltraplog":<Double_value>,
"botviolipreputation":<Double_value>,
"botviolstaticsignaturedroprate":<Double_value>,
"botviolwhitelistlog":<Double_value>,
"botvioldevicefingerprintrate":<Double_value>,
"botvioldevicefingerprintredirectrate":<Double_value>,
"botviolratelimitlograte":<Double_value>,
"botvioltrapredirectrate":<Double_value>,
"botviolratelimitdroprate":<Double_value>,
"botvioltpsrate":<Double_value>,
"botviolblacklistlograte":<Double_value>,
"botvioldevicefingerprintcaptcha":<Double_value>,
"botviolstaticsignaturelog":<Double_value>,
"botvioltpscaptcharate":<Double_value>,
"botviolcaptchadroprate":<Double_value>,
"botresponsesrate":<Double_value>,
"botviolstaticsignatureredirectrate":<Double_value>,
"botviolcaptcharedirectrate":<Double_value>,
"botvioldevicefingerprintcaptcharate":<Double_value>,
"botviolipreputationdroprate":<Double_value>,
"botresbytesrate":<Double_value>,
"botviolratelimitrate":<Double_value>,
"botviolipreputationlog":<Double_value>,
"botvioldevicefingerprintdrop":<Double_value>,
"botreqbytes":<Double_value>,
"botviolstaticsignaturelograte":<Double_value>,
"botviolstaticsignaturerate":<Double_value>,
"botviolipreputationcaptcharate":<Double_value>,
"botviolcaptchareset":<Double_value>,
"botviolipreputationreset":<Double_value>,
"botviolratelimitdrop":<Double_value>,
"botvioltpslograte":<Double_value>,
"botvioltpsresetrate":<Double_value>,
"botrequests":<Double_value>,
"botviolblacklistrate":<Double_value>,
"botviolipreputationredirectrate":<Double_value>,
"botvioltraplograte":<Double_value>,
"botviolcaptcharedirect":<Double_value>,
"botvioldevicefingerprintdroprate":<Double_value>,
"botvioltrapredirect":<Double_value>,
"botvioltpsdrop":<Double_value>,
"botvioltrapreset":<Double_value>,
"botviolratelimit":<Double_value>,
"botviolblacklistdroprate":<Double_value>,
"botviolcaptchadrop":<Double_value>,
"botviolipreputationrate":<Double_value>,
"botviolstaticsignatureredirect":<Double_value>,
"botvioltpsreset":<Double_value>,
"botvioltpsredirect":<Double_value>,
"botvioldevicefingerprintlograte":<Double_value>,
"botresponses":<Double_value>,
"botvioltpsredirectrate":<Double_value>,
"botviolcaptchalograte":<Double_value>,
"botvioltrapdrop":<Double_value>,
"botviolblacklistreset":<Double_value>,
"botviolratelimitredirectrate":<Double_value>,
"botviolwhitelistlograte":<Double_value>,
"botvioltpsdroprate":<Double_value>,
"botviolblacklistdrop":<Double_value>,
"botviolcaptcha":<Double_value>,
"botviolipreputationredirect":<Double_value>,
"botvioldevicefingerprintreset":<Double_value>,
"botvioltpscaptcha":<Double_value>,
"botviolipreputationdrop":<Double_value>,
"botviolstaticsignature":<Double_value>,
"botviolstaticsignaturedrop":<Double_value>,
"botviolratelimitreset":<Double_value>,
"botvioltrap":<Double_value>,
"botreqbytesrate":<Double_value>,
"botresbytes":<Double_value>,
"botviolcaptcharate":<Double_value>,
"botviolratelimitredirect":<Double_value>,
"botvioldevicefingerprintresetrate":<Double_value>,
"botviolratelimitlog":<Double_value>,
"botvioldevicefingerprintlog":<Double_value>,
"botviolstaticsignatureresetrate":<Double_value>,
"botvioltrapresetrate":<Double_value>,
"botviolwhitelistrate":<Double_value>,
"botviolwhitelist":<Double_value>,
"botviolblacklistlog":<Double_value>,
"botvioltpslog":<Double_value>,
"botviolblacklist":<Double_value>,
"botrequestsrate":<Double_value>,
"botviolipreputationresetrate":<Double_value>,
"botviolcaptcharesetrate":<Double_value>,
"botviolipreputationcaptcha":<Double_value>,
"botvioltrapdroprate":<Double_value>,
"botviolcaptchalog":<Double_value>,
"botvioltraprate":<Double_value>,
"botvioldevicefingerprint":<Double_value>,
"botvioldevicefingerprintredirect":<Double_value>,
"botviolblacklistresetrate":<Double_value>,
"botviolratelimitresetrate":<Double_value>
}]}
<!--NeedCopy-->
bot
In this article
Copied!
Failed!