Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

botprofile_captcha_binding

August 17, 2023
Contributed by: 
C

Binding object showing the captcha that can be bound to botprofile.

Properties

(click to see Operations )

Name Data Type Permissions Description
waittime Read-write Wait time in seconds for which ADC needs to wait for the Captcha response. This is to avoid DOS attacks.

Default value: 15

Minimum value = 10

Maximum value = 60
requestsizelimit Read-write Length of body request (in Bytes) up to (equal or less than) which captcha challenge will be provided to client. Above this length threshold the request will be dropped. This is to avoid DOS and DDOS attacks.

Default value: 8000

Minimum value = 10

Maximum value = 30000
bot_captcha_enabled Read-write Enable or disable the captcha binding.

Default value: OFF

Possible values = ON, OFF
name Read-write Name for the profile. Must begin with a letter, number, or the underscore character (), and must contain only letters, numbers, and the hyphen (-), period (.), pound (#), space ( ), at (@), equals (=), colon (:), and underscore () characters. Cannot be changed after the profile is added.The following requirement applies only to the Citrix ADC CLI If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my profile” or ‘my profile’). Minimum length = 1 Maximum length = 31
muteperiod Read-write Time (in seconds) duration for which client which failed captcha need to wait until allowed to try again. The requests from this client are silently dropped during the mute period.

Default value: 300

Minimum value = 60

Maximum value = 900
bot_bind_comment Read-write Any comments about this binding.

Minimum length = 1
graceperiod Read-write Time (in seconds) duration for which no new captcha challenge is sent after current captcha challenge has been answered successfully.

Default value: 900

Minimum value = 60

Maximum value = 900
bot_captcha_url Read-write URL for which the Captcha action, if configured under IP reputation, TPS or device fingerprint, need to be applied.

Minimum length = 1
logmessage Read-write Message to be logged for this binding.

Minimum length = 1
retryattempts Read-write Number of times client can retry solving the captcha.

Default value: 3

Minimum value = 1

Maximum value = 10
captcharesource Read-write Captcha action binding. For each URL, only one binding is allowed. If a binding exists for a URL and another binding is configured for the same URL, then the previous binding information is removed. Maximum 30 bindings can be configured per profile.
bot_captcha_action <String[]> Read-write One or more actions to be taken when client fails captcha challenge. Only, log action can be configured with DROP, REDIRECT or RESET action.

Default value: NONE

Possible values = NONE, LOG, DROP, REDIRECT, RESET
__count Read-write count parameter

Operations

(click to see Properties )

  • ADD
  • DELETE
  • GET
  • GET (ALL)
  • COUNT

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

add

URL: http:// <netscaler-ip-address /nitro/v1/config/botprofile_captcha_binding

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{
"botprofile_captcha_binding":{
<b>      "name":<String_value>,
</b>      "captcharesource":<Boolean_value>,
      "bot_captcha_url":<String_value>,
      "waittime":<Double_value>,
      "graceperiod":<Double_value>,
      "muteperiod":<Double_value>,
      "requestsizelimit":<Double_value>,
      "retryattempts":<Double_value>,
      "bot_captcha_action":<String[]_value>,
      "bot_captcha_enabled":<String_value>,
      "logmessage":<String_value>,
      "bot_bind_comment":<String_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 201 Created

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

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/botprofile_captcha_binding/ name_value<String>

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/config/botprofile_captcha_binding/ name_value<String> ? args=captcharesource: <Boolean_value> ,bot_captcha_url: <String_value>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

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

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/botprofile_captcha_binding/ name_value<String>

Query-parameters:

filter

http:// <netscaler-ip-address> /nitro/v1/config/botprofile_captcha_binding/ name_value<String> ? filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of botprofile_captcha_binding resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

pagination

http:// <netscaler-ip-address> /nitro/v1/config/botprofile_captcha_binding/ name_value<String> ? pagesize=#no;pageno=#no

Use this query-parameter to get the botprofile_captcha_binding resources in chunks.

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_captcha_binding": [ {
      "waittime":<Double_value>,
      "requestsizelimit":<Double_value>,
      "bot_captcha_enabled":<String_value>,
      "name":<String_value>,
      "muteperiod":<Double_value>,
      "bot_bind_comment":<String_value>,
      "graceperiod":<Double_value>,
      "bot_captcha_url":<String_value>,
      "logmessage":<String_value>,
      "retryattempts":<Double_value>,
      "captcharesource":<Boolean_value>,
      "bot_captcha_action":<String[]_value>
}]}

<!--NeedCopy-->

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/botprofile_captcha_binding

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Query-parameters:

bulkbindings

http:// <netscaler-ip-address> /nitro/v1/config/botprofile_captcha_binding? bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

Note: get (all) method can be used only in conjuction with bulkbindings query parameter.

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_captcha_binding": [ {
      "waittime":<Double_value>,
      "requestsizelimit":<Double_value>,
      "bot_captcha_enabled":<String_value>,
      "name":<String_value>,
      "muteperiod":<Double_value>,
      "bot_bind_comment":<String_value>,
      "graceperiod":<Double_value>,
      "bot_captcha_url":<String_value>,
      "logmessage":<String_value>,
      "retryattempts":<Double_value>,
      "captcharesource":<Boolean_value>,
      "bot_captcha_action":<String[]_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/botprofile_captcha_binding/ name_value<String> ? count=yes

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_captcha_binding": [ { "__count": "#no"} ] }

<!--NeedCopy-->
botprofile_captcha_binding
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.