Skip to content

botprofile

Statistics for Bot profile resource.

Properties

(click to see Operations )

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

Minimum length = 1

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

Possible values = basic, full
botvioldevicefingerprintprofile <Double> Read-only Number of device fingerprint violations seen by the Bot profile.
botvioldevicefingerprintprofilerate <Double> Read-only Rate (/s) counter for botvioldevicefingerprintprofile
botvioldevicefingerprintlogprofile <Double> Read-only Number of device fingerprint violations logged by the Bot profile.
botvioldevicefingerprintlogprofilerate <Double> Read-only Rate (/s) counter for botvioldevicefingerprintlogprofile
botvioldevicefingerprintdropprofile <Double> Read-only Number of device fingerprint violations dropped by the Bot profile.
botvioldevicefingerprintdropprofilerate <Double> Read-only Rate (/s) counter for botvioldevicefingerprintdropprofile
botvioldevicefingerprintredirectprofile <Double> Read-only Number of device fingerprint violations requests redirected by the Bot profile to a different Web page or web server.
botvioldevicefingerprintredirectprofilerate <Double> Read-only Rate (/s) counter for botvioldevicefingerprintredirectprofile
botviolipreputationprofile <Double> Read-only Number of ip reputation violations seen by the Bot profile.
botviolipreputationprofilerate <Double> Read-only Rate (/s) counter for botviolipreputationprofile
botviolipreputationlogprofile <Double> Read-only Number of ip reputation violations logged by the Bot Profile.
botviolipreputationlogprofilerate <Double> Read-only Rate (/s) counter for botviolipreputationlogprofile
botviolipreputationdropprofile <Double> Read-only Number of ip reputation violations dropped by the Bot profile.
botviolipreputationdropprofilerate <Double> Read-only Rate (/s) counter for botviolipreputationdropprofile
botviolipreputationredirectprofile <Double> Read-only Number of ip reputation violations requests redirected by the Bot profile to a different Web page or web server.
botviolipreputationredirectprofilerate <Double> Read-only Rate (/s) counter for botviolipreputationredirectprofile
botviolwhitelistprofile <Double> Read-only Number of white list violations seen by the Bot profile.
botviolwhitelistprofilerate <Double> Read-only Rate (/s) counter for botviolwhitelistprofile
botviolwhitelistlogprofile <Double> Read-only Number of white list violations logged by the Bot profile.
botviolwhitelistlogprofilerate <Double> Read-only Rate (/s) counter for botviolwhitelistlogprofile
botviolblacklistprofile <Double> Read-only Number of black list violations seen by the Bot profile.
botviolblacklistprofilerate <Double> Read-only Rate (/s) counter for botviolblacklistprofile
botviolblacklistlogprofile <Double> Read-only Number of black list violations logged by the Bot profile.
botviolblacklistlogprofilerate <Double> Read-only Rate (/s) counter for botviolblacklistlogprofile
botviolblacklistdropprofile <Double> Read-only Number of black list violations dropped by the Bot profile.
botviolblacklistdropprofilerate <Double> Read-only Rate (/s) counter for botviolblacklistdropprofile
botviolblacklistredirectprofile <Double> Read-only Number of black list violations redirected by the Bot profile to a different Web page or web server.
botviolblacklistredirectprofilerate <Double> Read-only Rate (/s) counter for botviolblacklistredirectprofile
botviolratelimitprofile <Double> Read-only Number of rate limiting violations seen by the Bot profile.
botviolratelimitprofilerate <Double> Read-only Rate (/s) counter for botviolratelimitprofile
botviolratelimitlogprofile <Double> Read-only Number of rate limiting violations logged by the Bot profile.
botviolratelimitlogprofilerate <Double> Read-only Rate (/s) counter for botviolratelimitlogprofile
botviolratelimitdropprofile <Double> Read-only Number of rate limiting violations dropped by the Bot profile.
botviolratelimitdropprofilerate <Double> Read-only Rate (/s) counter for botviolratelimitdropprofile
botviolratelimitredirectprofile <Double> Read-only Number of rate limiting violations requests redirected by the Bot profile to a different Web page or web server.
botviolratelimitredirectprofilerate <Double> Read-only Rate (/s) counter for botviolratelimitredirectprofile
botviolstaticsignatureprofile <Double> Read-only Number of static signatutre violations seen by the Bot profile.
botviolstaticsignatureprofilerate <Double> Read-only Rate (/s) counter for botviolstaticsignatureprofile
botviolstaticsignaturelogprofile <Double> Read-only Number of static signatutre violations logged by the Bot profile.
botviolstaticsignaturelogprofilerate <Double> Read-only Rate (/s) counter for botviolstaticsignaturelogprofile
botviolstaticsignaturedropprofile <Double> Read-only Number of static signatutre violations dropped by the Bot profile.
botviolstaticsignaturedropprofilerate <Double> Read-only Rate (/s) counter for botviolstaticsignaturedropprofile
botviolstaticsignatureredirectprofile <Double> Read-only Number of static signatutre violations redirected by the Bot profile to a different Web page or web server.
botviolstaticsignatureredirectprofilerate <Double> Read-only Rate (/s) counter for botviolstaticsignatureredirectprofile
botrequestsperprofile <Double> Read-only HTTP/HTTPS requests sent to your protected web servers via the Bot profile.
botrequestsperprofilerate <Double> Read-only Rate (/s) counter for botrequestsperprofile
botreqbytesperprofile <Double> Read-only Number of bytes transfered for requests
botreqbytesperprofilerate <Double> Read-only Rate (/s) counter for botreqbytesperprofile
botresponsesperprofile <Double> Read-only HTTP/HTTPS responses sent by your protected web servers via the Bot profile.
botresponsesperprofilerate <Double> Read-only Rate (/s) counter for botresponsesperprofile
botresbytesperprofile <Double> Read-only Number of bytes transfered for responses
botresbytesperprofilerate <Double> 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>,
      "botvioldevicefingerprintredirectprofilerate":<Double_value>,
      "botviolipreputationlogprofilerate":<Double_value>,
      "botvioldevicefingerprintredirectprofile":<Double_value>,
      "botviolwhitelistprofilerate":<Double_value>,
      "botviolipreputationredirectprofile":<Double_value>,
      "botresponsesperprofilerate":<Double_value>,
      "botviolstaticsignaturedropprofile":<Double_value>,
      "botviolratelimitlogprofilerate":<Double_value>,
      "botviolwhitelistlogprofile":<Double_value>,
      "botviolipreputationlogprofile":<Double_value>,
      "botviolblacklistlogprofile":<Double_value>,
      "botviolratelimitlogprofile":<Double_value>,
      "botrequestsperprofilerate":<Double_value>,
      "botviolipreputationprofilerate":<Double_value>,
      "botvioldevicefingerprintdropprofilerate":<Double_value>,
      "botviolstaticsignatureprofile":<Double_value>,
      "botviolblacklistredirectprofile":<Double_value>,
      "botviolratelimitprofile":<Double_value>,
      "botviolblacklistdropprofile":<Double_value>,
      "botreqbytesperprofilerate":<Double_value>,
      "botviolratelimitredirectprofilerate":<Double_value>,
      "botviolipreputationprofile":<Double_value>,
      "botviolstaticsignaturelogprofilerate":<Double_value>,
      "botviolstaticsignaturelogprofile":<Double_value>,
      "botvioldevicefingerprintdropprofile":<Double_value>,
      "botviolblacklistprofile":<Double_value>,
      "botviolipreputationdropprofile":<Double_value>,
      "botresbytesperprofilerate":<Double_value>,
      "botviolblacklistredirectprofilerate":<Double_value>,
      "botresponsesperprofile":<Double_value>,
      "botviolstaticsignatureredirectprofile":<Double_value>,
      "botviolblacklistdropprofilerate":<Double_value>,
      "botviolipreputationredirectprofilerate":<Double_value>,
      "botviolstaticsignatureprofilerate":<Double_value>,
      "botvioldevicefingerprintlogprofilerate":<Double_value>,
      "botviolratelimitdropprofilerate":<Double_value>,
      "botvioldevicefingerprintprofile":<Double_value>,
      "botresbytesperprofile":<Double_value>,
      "botviolwhitelistlogprofilerate":<Double_value>,
      "botviolblacklistlogprofilerate":<Double_value>,
      "botviolratelimitdropprofile":<Double_value>,
      "botrequestsperprofile":<Double_value>,
      "botviolwhitelistprofile":<Double_value>,
      "botviolratelimitprofilerate":<Double_value>,
      "botviolratelimitredirectprofile":<Double_value>,
      "botviolblacklistprofilerate":<Double_value>,
      "botviolstaticsignaturedropprofilerate":<Double_value>,
      "botreqbytesperprofile":<Double_value>,
      "botvioldevicefingerprintprofilerate":<Double_value>,
      "botviolstaticsignatureredirectprofilerate":<Double_value>,
      "botviolipreputationdropprofilerate":<Double_value>
}]}

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>,
      "botvioldevicefingerprintredirectprofilerate":<Double_value>,
      "botviolipreputationlogprofilerate":<Double_value>,
      "botvioldevicefingerprintredirectprofile":<Double_value>,
      "botviolwhitelistprofilerate":<Double_value>,
      "botviolipreputationredirectprofile":<Double_value>,
      "botresponsesperprofilerate":<Double_value>,
      "botviolstaticsignaturedropprofile":<Double_value>,
      "botviolratelimitlogprofilerate":<Double_value>,
      "botviolwhitelistlogprofile":<Double_value>,
      "botviolipreputationlogprofile":<Double_value>,
      "botviolblacklistlogprofile":<Double_value>,
      "botviolratelimitlogprofile":<Double_value>,
      "botrequestsperprofilerate":<Double_value>,
      "botviolipreputationprofilerate":<Double_value>,
      "botvioldevicefingerprintdropprofilerate":<Double_value>,
      "botviolstaticsignatureprofile":<Double_value>,
      "botviolblacklistredirectprofile":<Double_value>,
      "botviolratelimitprofile":<Double_value>,
      "botviolblacklistdropprofile":<Double_value>,
      "botreqbytesperprofilerate":<Double_value>,
      "botviolratelimitredirectprofilerate":<Double_value>,
      "botviolipreputationprofile":<Double_value>,
      "botviolstaticsignaturelogprofilerate":<Double_value>,
      "botviolstaticsignaturelogprofile":<Double_value>,
      "botvioldevicefingerprintdropprofile":<Double_value>,
      "botviolblacklistprofile":<Double_value>,
      "botviolipreputationdropprofile":<Double_value>,
      "botresbytesperprofilerate":<Double_value>,
      "botviolblacklistredirectprofilerate":<Double_value>,
      "botresponsesperprofile":<Double_value>,
      "botviolstaticsignatureredirectprofile":<Double_value>,
      "botviolblacklistdropprofilerate":<Double_value>,
      "botviolipreputationredirectprofilerate":<Double_value>,
      "botviolstaticsignatureprofilerate":<Double_value>,
      "botvioldevicefingerprintlogprofilerate":<Double_value>,
      "botviolratelimitdropprofilerate":<Double_value>,
      "botvioldevicefingerprintprofile":<Double_value>,
      "botresbytesperprofile":<Double_value>,
      "botviolwhitelistlogprofilerate":<Double_value>,
      "botviolblacklistlogprofilerate":<Double_value>,
      "botviolratelimitdropprofile":<Double_value>,
      "botrequestsperprofile":<Double_value>,
      "botviolwhitelistprofile":<Double_value>,
      "botviolratelimitprofilerate":<Double_value>,
      "botviolratelimitredirectprofile":<Double_value>,
      "botviolblacklistprofilerate":<Double_value>,
      "botviolstaticsignaturedropprofilerate":<Double_value>,
      "botreqbytesperprofile":<Double_value>,
      "botvioldevicefingerprintprofilerate":<Double_value>,
      "botviolstaticsignatureredirectprofilerate":<Double_value>,
      "botviolipreputationdropprofilerate":<Double_value>
}]}