ADC NITRO APIs

botprofile

Statistics for Bot profile resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
name Read-write Name of the bot profile.

Minimum length = 1

Maximum length = 31
clearstats Read-write Clear the statsistics / counters.

Possible values = basic, full
botvioldevicefingerprintprofile Read-only Number of device fingerprint violations seen by the Bot profile.
botvioldevicefingerprintprofilerate Read-only Rate (/s) counter for botvioldevicefingerprintprofile
botvioldevicefingerprintlogprofile Read-only Number of device fingerprint violations logged by the Bot profile.
botvioldevicefingerprintlogprofilerate Read-only Rate (/s) counter for botvioldevicefingerprintlogprofile
botvioldevicefingerprintdropprofile Read-only Number of device fingerprint violations dropped by the Bot profile.
botvioldevicefingerprintdropprofilerate Read-only Rate (/s) counter for botvioldevicefingerprintdropprofile
botvioldevicefingerprintredirectprofile Read-only Number of device fingerprint violations requests redirected by the Bot profile to a different Web page or web server.
botvioldevicefingerprintredirectprofilerate Read-only Rate (/s) counter for botvioldevicefingerprintredirectprofile
botvioldevicefingerprintcaptchaprofile Read-only Number of device fingerprint violation requests for which CAPTCHA challenge was sent due to Bot profile.
botvioldevicefingerprintcaptchaprofilerate Read-only Rate (/s) counter for botvioldevicefingerprintcaptchaprofile
botvioldevicefingerprintresetprofile Read-only Number of device fingerprint violations reset by the Bot profile.
botvioldevicefingerprintresetprofilerate Read-only Rate (/s) counter for botvioldevicefingerprintresetprofile
botviolipreputationprofile Read-only Number of ip reputation violations seen by the Bot profile.
botviolipreputationprofilerate Read-only Rate (/s) counter for botviolipreputationprofile
botviolipreputationlogprofile Read-only Number of ip reputation violations logged by the Bot Profile.
botviolipreputationlogprofilerate Read-only Rate (/s) counter for botviolipreputationlogprofile
botviolipreputationdropprofile Read-only Number of ip reputation violations dropped by the Bot profile.
botviolipreputationdropprofilerate Read-only Rate (/s) counter for botviolipreputationdropprofile
botviolipreputationredirectprofile Read-only Number of ip reputation violations requests redirected by the Bot profile to a different Web page or web server.
botviolipreputationredirectprofilerate Read-only Rate (/s) counter for botviolipreputationredirectprofile
botviolipreputationcaptchaprofile Read-only Number of ip reputation violation requests for which CAPTCHA challenge was sent due to Bot profile.
botviolipreputationcaptchaprofilerate Read-only Rate (/s) counter for botviolipreputationcaptchaprofile
botviolipreputationresetprofile Read-only Number of ip reputation violations reset by the Bot profile.
botviolipreputationresetprofilerate Read-only Rate (/s) counter for botviolipreputationresetprofile
botviolwhitelistprofile Read-only Number of white list violations seen by the Bot profile.
botviolwhitelistprofilerate Read-only Rate (/s) counter for botviolwhitelistprofile
botviolwhitelistlogprofile Read-only Number of white list violations logged by the Bot profile.
botviolwhitelistlogprofilerate Read-only Rate (/s) counter for botviolwhitelistlogprofile
botviolblacklistprofile Read-only Number of black list violations seen by the Bot profile.
botviolblacklistprofilerate Read-only Rate (/s) counter for botviolblacklistprofile
botviolblacklistlogprofile Read-only Number of black list violations logged by the Bot profile.
botviolblacklistlogprofilerate Read-only Rate (/s) counter for botviolblacklistlogprofile
botviolblacklistdropprofile Read-only Number of black list violations dropped by the Bot profile.
botviolblacklistdropprofilerate Read-only Rate (/s) counter for botviolblacklistdropprofile
botviolblacklistresetprofile Read-only Number of black list violations reset by the Bot profile.
botviolblacklistresetprofilerate Read-only Rate (/s) counter for botviolblacklistresetprofile
botviolratelimitprofile Read-only Number of rate limiting violations seen by the Bot profile.
botviolratelimitprofilerate Read-only Rate (/s) counter for botviolratelimitprofile
botviolratelimitlogprofile Read-only Number of rate limiting violations logged by the Bot profile.
botviolratelimitlogprofilerate Read-only Rate (/s) counter for botviolratelimitlogprofile
botviolratelimitdropprofile Read-only Number of rate limiting violations dropped by the Bot profile.
botviolratelimitdropprofilerate Read-only Rate (/s) counter for botviolratelimitdropprofile
botviolratelimitredirectprofile Read-only Number of rate limiting violations requests redirected by the Bot profile to a different Web page or web server.
botviolratelimitredirectprofilerate Read-only Rate (/s) counter for botviolratelimitredirectprofile
botviolratelimitresetprofile Read-only Number of rate limiting violations reset by the Bot profile.
botviolratelimitresetprofilerate Read-only Rate (/s) counter for botviolratelimitresetprofile
botviolstaticsignatureprofile Read-only Number of static signatutre violations seen by the Bot profile.
botviolstaticsignatureprofilerate Read-only Rate (/s) counter for botviolstaticsignatureprofile
botviolstaticsignaturelogprofile Read-only Number of static signatutre violations logged by the Bot profile.
botviolstaticsignaturelogprofilerate Read-only Rate (/s) counter for botviolstaticsignaturelogprofile
botviolstaticsignaturedropprofile Read-only Number of static signatutre violations dropped by the Bot profile.
botviolstaticsignaturedropprofilerate Read-only Rate (/s) counter for botviolstaticsignaturedropprofile
botviolstaticsignatureredirectprofile Read-only Number of static signatutre violations redirected by the Bot profile to a different Web page or web server.
botviolstaticsignatureredirectprofilerate Read-only Rate (/s) counter for botviolstaticsignatureredirectprofile
botviolstaticsignatureresetprofile Read-only Number of static signatutre violations reset by the Bot profile to a different Web page or web server.
botviolstaticsignatureresetprofilerate Read-only Rate (/s) counter for botviolstaticsignatureresetprofile
botvioltpsprofile Read-only Number of tps violations seen by the Bot profile.
botvioltpsprofilerate Read-only Rate (/s) counter for botvioltpsprofile
botvioltpslogprofile Read-only Number of tps violations logged by the Bot profile.
botvioltpslogprofilerate Read-only Rate (/s) counter for botvioltpslogprofile
botvioltpsdropprofile Read-only Number of tps violations dropped by the Bot profile.
botvioltpsdropprofilerate Read-only Rate (/s) counter for botvioltpsdropprofile
botvioltpsredirectprofile Read-only Number of tps violations requests redirected by the Bot profile to a different Web page or web server.
botvioltpsredirectprofilerate Read-only Rate (/s) counter for botvioltpsredirectprofile
botvioltpsresetprofile Read-only Number of tps violations reset by the Bot profile.
botvioltpsresetprofilerate Read-only Rate (/s) counter for botvioltpsresetprofile
botvioltpscaptchaprofile Read-only Number of tps violation requests for which CAPTCHA challenge was sent due to Bot profile.
botvioltpscaptchaprofilerate Read-only Rate (/s) counter for botvioltpscaptchaprofile
botviolcaptchaprofile Read-only Number of Captcha challenge failures seen by the Bot profile.
botviolcaptchaprofilerate Read-only Rate (/s) counter for botviolcaptchaprofile
botviolcaptchalogprofile Read-only Number of Captcha challenge failures logged by the Bot profile.
botviolcaptchalogprofilerate Read-only Rate (/s) counter for botviolcaptchalogprofile
botviolcaptchadropprofile Read-only Number of Captcha challenge failures dropped by the Bot profile.
botviolcaptchadropprofilerate Read-only Rate (/s) counter for botviolcaptchadropprofile
botviolcaptcharedirectprofile Read-only Number of Captcha challenge failures redirected by the Bot profile.
botviolcaptcharedirectprofilerate Read-only Rate (/s) counter for botviolcaptcharedirectprofile
botviolcaptcharesetprofile Read-only Number of Captcha challenge failures reset by the Bot profile.
botviolcaptcharesetprofilerate Read-only Rate (/s) counter for botviolcaptcharesetprofile
botvioltrapprofile Read-only Number of trap violations seen by the Bot profile.
botvioltrapprofilerate Read-only Rate (/s) counter for botvioltrapprofile
botvioltraplogprofile Read-only Number of trap violations logged by the Bot profile.
botvioltraplogprofilerate Read-only Rate (/s) counter for botvioltraplogprofile
botvioltrapdropprofile Read-only Number of trap violations dropped by the Bot profile.
botvioltrapdropprofilerate Read-only Rate (/s) counter for botvioltrapdropprofile
botvioltrapredirectprofile Read-only Number of trap violations requests redirected by the Bot profile to a different Web page or web server.
botvioltrapredirectprofilerate Read-only Rate (/s) counter for botvioltrapredirectprofile
botvioltrapresetprofile Read-only Number of trap violations reset by the Bot profile.
botvioltrapresetprofilerate Read-only Rate (/s) counter for botvioltrapresetprofile
botrequestsperprofile Read-only HTTP/HTTPS requests sent to your protected web servers via the Bot profile.
botrequestsperprofilerate Read-only Rate (/s) counter for botrequestsperprofile
botreqbytesperprofile Read-only Number of bytes transfered for requests
botreqbytesperprofilerate Read-only Rate (/s) counter for botreqbytesperprofile
botresponsesperprofile Read-only HTTP/HTTPS responses sent by your protected web servers via the Bot profile.
botresponsesperprofilerate Read-only Rate (/s) counter for botresponsesperprofile
botresbytesperprofile Read-only Number of bytes transfered for responses
botresbytesperprofilerate Read-only Rate (/s) counter for botresbytesperprofile

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

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/stat/botprofile? 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 botprofile 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:


{  "botprofile": [ {
      "name":<String_value>,
      "botvioldevicefingerprintlogprofile":<Double_value>,
      "botviolipreputationredirectprofile":<Double_value>,
      "botviolratelimitresetprofilerate":<Double_value>,
      "botviolstaticsignaturedropprofile":<Double_value>,
      "botviolstaticsignatureresetprofile":<Double_value>,
      "botviolratelimitlogprofilerate":<Double_value>,
      "botviolipreputationcaptchaprofile":<Double_value>,
      "botviolratelimitlogprofile":<Double_value>,
      "botviolipreputationprofilerate":<Double_value>,
      "botvioldevicefingerprintdropprofilerate":<Double_value>,
      "botviolblacklistresetprofile":<Double_value>,
      "botvioltraplogprofilerate":<Double_value>,
      "botviolratelimitprofile":<Double_value>,
      "botviolblacklistdropprofile":<Double_value>,
      "botreqbytesperprofilerate":<Double_value>,
      "botviolratelimitredirectprofilerate":<Double_value>,
      "botvioltrapredirectprofilerate":<Double_value>,
      "botviolipreputationprofile":<Double_value>,
      "botviolstaticsignaturelogprofilerate":<Double_value>,
      "botviolstaticsignaturelogprofile":<Double_value>,
      "botresbytesperprofilerate":<Double_value>,
      "botviolstaticsignatureredirectprofile":<Double_value>,
      "botviolstaticsignatureresetprofilerate":<Double_value>,
      "botviolblacklistresetprofilerate":<Double_value>,
      "botviolipreputationredirectprofilerate":<Double_value>,
      "botviolstaticsignatureprofilerate":<Double_value>,
      "botviolcaptchadropprofilerate":<Double_value>,
      "botviolratelimitdropprofilerate":<Double_value>,
      "botvioldevicefingerprintprofile":<Double_value>,
      "botviolipreputationresetprofile":<Double_value>,
      "botviolratelimitresetprofile":<Double_value>,
      "botviolcaptchaprofile":<Double_value>,
      "botvioldevicefingerprintresetprofilerate":<Double_value>,
      "botvioltrapdropprofile":<Double_value>,
      "botresbytesperprofile":<Double_value>,
      "botviolcaptchalogprofile":<Double_value>,
      "botviolblacklistlogprofilerate":<Double_value>,
      "botviolcaptchadropprofile":<Double_value>,
      "botvioltrapdropprofilerate":<Double_value>,
      "botviolratelimitdropprofile":<Double_value>,
      "botrequestsperprofile":<Double_value>,
      "botviolratelimitredirectprofile":<Double_value>,
      "botvioltpsdropprofile":<Double_value>,
      "botviolblacklistprofilerate":<Double_value>,
      "botviolstaticsignaturedropprofilerate":<Double_value>,
      "botvioltpsprofile":<Double_value>,
      "botreqbytesperprofile":<Double_value>,
      "botvioldevicefingerprintprofilerate":<Double_value>,
      "botviolstaticsignatureredirectprofilerate":<Double_value>,
      "botvioldevicefingerprintredirectprofilerate":<Double_value>,
      "botviolipreputationlogprofilerate":<Double_value>,
      "botvioldevicefingerprintredirectprofile":<Double_value>,
      "botvioltrapresetprofile":<Double_value>,
      "botviolwhitelistprofilerate":<Double_value>,
      "botvioltpsresetprofile":<Double_value>,
      "botresponsesperprofilerate":<Double_value>,
      "botviolwhitelistlogprofile":<Double_value>,
      "botviolipreputationlogprofile":<Double_value>,
      "botviolblacklistlogprofile":<Double_value>,
      "botrequestsperprofilerate":<Double_value>,
      "botviolcaptcharedirectprofilerate":<Double_value>,
      "botviolipreputationcaptchaprofilerate":<Double_value>,
      "botviolstaticsignatureprofile":<Double_value>,
      "botvioltpscaptchaprofilerate":<Double_value>,
      "botviolcaptchaprofilerate":<Double_value>,
      "botvioldevicefingerprintdropprofile":<Double_value>,
      "botviolblacklistprofile":<Double_value>,
      "botvioldevicefingerprintresetprofile":<Double_value>,
      "botvioltraplogprofile":<Double_value>,
      "botviolipreputationdropprofile":<Double_value>,
      "botvioldevicefingerprintcaptchaprofilerate":<Double_value>,
      "botresponsesperprofile":<Double_value>,
      "botvioltrapredirectprofile":<Double_value>,
      "botviolcaptchalogprofilerate":<Double_value>,
      "botvioltpsredirectprofilerate":<Double_value>,
      "botviolblacklistdropprofilerate":<Double_value>,
      "botviolcaptcharesetprofilerate":<Double_value>,
      "botvioltpslogprofilerate":<Double_value>,
      "botvioltpsredirectprofile":<Double_value>,
      "botvioldevicefingerprintlogprofilerate":<Double_value>,
      "botviolipreputationresetprofilerate":<Double_value>,
      "botvioltpslogprofile":<Double_value>,
      "botvioltpsdropprofilerate":<Double_value>,
      "botvioltpsresetprofilerate":<Double_value>,
      "botvioltrapprofilerate":<Double_value>,
      "botvioltrapprofile":<Double_value>,
      "botviolcaptcharesetprofile":<Double_value>,
      "botviolwhitelistlogprofilerate":<Double_value>,
      "botvioltrapresetprofilerate":<Double_value>,
      "botvioldevicefingerprintcaptchaprofile":<Double_value>,
      "botviolcaptcharedirectprofile":<Double_value>,
      "botviolwhitelistprofile":<Double_value>,
      "botviolratelimitprofilerate":<Double_value>,
      "botvioltpscaptchaprofile":<Double_value>,
      "botvioltpsprofilerate":<Double_value>,
      "botviolipreputationdropprofilerate":<Double_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/stat/botprofile/ 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:


{  "botprofile": [ {
      "name":<String_value>,
      "botvioldevicefingerprintlogprofile":<Double_value>,
      "botviolipreputationredirectprofile":<Double_value>,
      "botviolratelimitresetprofilerate":<Double_value>,
      "botviolstaticsignaturedropprofile":<Double_value>,
      "botviolstaticsignatureresetprofile":<Double_value>,
      "botviolratelimitlogprofilerate":<Double_value>,
      "botviolipreputationcaptchaprofile":<Double_value>,
      "botviolratelimitlogprofile":<Double_value>,
      "botviolipreputationprofilerate":<Double_value>,
      "botvioldevicefingerprintdropprofilerate":<Double_value>,
      "botviolblacklistresetprofile":<Double_value>,
      "botvioltraplogprofilerate":<Double_value>,
      "botviolratelimitprofile":<Double_value>,
      "botviolblacklistdropprofile":<Double_value>,
      "botreqbytesperprofilerate":<Double_value>,
      "botviolratelimitredirectprofilerate":<Double_value>,
      "botvioltrapredirectprofilerate":<Double_value>,
      "botviolipreputationprofile":<Double_value>,
      "botviolstaticsignaturelogprofilerate":<Double_value>,
      "botviolstaticsignaturelogprofile":<Double_value>,
      "botresbytesperprofilerate":<Double_value>,
      "botviolstaticsignatureredirectprofile":<Double_value>,
      "botviolstaticsignatureresetprofilerate":<Double_value>,
      "botviolblacklistresetprofilerate":<Double_value>,
      "botviolipreputationredirectprofilerate":<Double_value>,
      "botviolstaticsignatureprofilerate":<Double_value>,
      "botviolcaptchadropprofilerate":<Double_value>,
      "botviolratelimitdropprofilerate":<Double_value>,
      "botvioldevicefingerprintprofile":<Double_value>,
      "botviolipreputationresetprofile":<Double_value>,
      "botviolratelimitresetprofile":<Double_value>,
      "botviolcaptchaprofile":<Double_value>,
      "botvioldevicefingerprintresetprofilerate":<Double_value>,
      "botvioltrapdropprofile":<Double_value>,
      "botresbytesperprofile":<Double_value>,
      "botviolcaptchalogprofile":<Double_value>,
      "botviolblacklistlogprofilerate":<Double_value>,
      "botviolcaptchadropprofile":<Double_value>,
      "botvioltrapdropprofilerate":<Double_value>,
      "botviolratelimitdropprofile":<Double_value>,
      "botrequestsperprofile":<Double_value>,
      "botviolratelimitredirectprofile":<Double_value>,
      "botvioltpsdropprofile":<Double_value>,
      "botviolblacklistprofilerate":<Double_value>,
      "botviolstaticsignaturedropprofilerate":<Double_value>,
      "botvioltpsprofile":<Double_value>,
      "botreqbytesperprofile":<Double_value>,
      "botvioldevicefingerprintprofilerate":<Double_value>,
      "botviolstaticsignatureredirectprofilerate":<Double_value>,
      "botvioldevicefingerprintredirectprofilerate":<Double_value>,
      "botviolipreputationlogprofilerate":<Double_value>,
      "botvioldevicefingerprintredirectprofile":<Double_value>,
      "botvioltrapresetprofile":<Double_value>,
      "botviolwhitelistprofilerate":<Double_value>,
      "botvioltpsresetprofile":<Double_value>,
      "botresponsesperprofilerate":<Double_value>,
      "botviolwhitelistlogprofile":<Double_value>,
      "botviolipreputationlogprofile":<Double_value>,
      "botviolblacklistlogprofile":<Double_value>,
      "botrequestsperprofilerate":<Double_value>,
      "botviolcaptcharedirectprofilerate":<Double_value>,
      "botviolipreputationcaptchaprofilerate":<Double_value>,
      "botviolstaticsignatureprofile":<Double_value>,
      "botvioltpscaptchaprofilerate":<Double_value>,
      "botviolcaptchaprofilerate":<Double_value>,
      "botvioldevicefingerprintdropprofile":<Double_value>,
      "botviolblacklistprofile":<Double_value>,
      "botvioldevicefingerprintresetprofile":<Double_value>,
      "botvioltraplogprofile":<Double_value>,
      "botviolipreputationdropprofile":<Double_value>,
      "botvioldevicefingerprintcaptchaprofilerate":<Double_value>,
      "botresponsesperprofile":<Double_value>,
      "botvioltrapredirectprofile":<Double_value>,
      "botviolcaptchalogprofilerate":<Double_value>,
      "botvioltpsredirectprofilerate":<Double_value>,
      "botviolblacklistdropprofilerate":<Double_value>,
      "botviolcaptcharesetprofilerate":<Double_value>,
      "botvioltpslogprofilerate":<Double_value>,
      "botvioltpsredirectprofile":<Double_value>,
      "botvioldevicefingerprintlogprofilerate":<Double_value>,
      "botviolipreputationresetprofilerate":<Double_value>,
      "botvioltpslogprofile":<Double_value>,
      "botvioltpsdropprofilerate":<Double_value>,
      "botvioltpsresetprofilerate":<Double_value>,
      "botvioltrapprofilerate":<Double_value>,
      "botvioltrapprofile":<Double_value>,
      "botviolcaptcharesetprofile":<Double_value>,
      "botviolwhitelistlogprofilerate":<Double_value>,
      "botvioltrapresetprofilerate":<Double_value>,
      "botvioldevicefingerprintcaptchaprofile":<Double_value>,
      "botviolcaptcharedirectprofile":<Double_value>,
      "botviolwhitelistprofile":<Double_value>,
      "botviolratelimitprofilerate":<Double_value>,
      "botvioltpscaptchaprofile":<Double_value>,
      "botvioltpsprofilerate":<Double_value>,
      "botviolipreputationdropprofilerate":<Double_value>
}]}

<!--NeedCopy-->
botprofile