botsignature

Last published : Oct 30, 2026
Configuration for bot signatures resource.
Related information
Configuration

Properties

(click to see Operations )
Name Data Type Permissions Description
src <String> Read-write Local path to and name of, or URL (protocol, host, path, and file name) for, the file in which to store the imported signature file.
NOTE: The import fails if the object to be imported is on an HTTPS server that requires client certificate authentication for access.
Minimum length = 1
Maximum length = 2047
name <String> Read-write Name to assign to the bot signature file object on the Citrix ADC.
Minimum length = 1
Maximum length = 31
comment <String> Read-write Any comments to preserve information about the signature file object.
Maximum length = 128
overwrite <Boolean> Read-write Overwrites the existing file.
response <String> Read-only .

Operations

(click to see Properties )
  • IMPORT
  • DELETE
  • CHANGE
  • 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

Import

URL: http:// <netscaler-ip-address> /nitro/v1/config/botsignature? action=Import HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:

{"botsignature":{
"src":<String_value>,
<b>"name":<String_value>,
</b>"comment":<String_value>,
"overwrite":<Boolean_value>
}}
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

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/botsignature/ name_value<String> 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

change

URL: http:// <netscaler-ip-address> /nitro/v1/config/botsignature? action=update HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:

{"botsignature":{
<b>"name":<String_value>
</b>}}
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 (all)

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

{ "botsignature": [ {
"name":<String_value>,
"response":<String_value>,
"src":<String_value>
}]}

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/botsignature/ name_value<String> Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/botsignature/ name_value<String> ? attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
view http:// <netscaler-ip-address> /nitro/v1/config/botsignature/ name_value<String> ? view=summary
Use this query-parameter to get the summary output of botsignature resources configured on NetScaler.
Note: By default, the retrieved results are displayed in detail view (?view=detail).
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:

{  "botsignature": [ {
"name":<String_value>,
"response":<String_value>,
"src":<String_value>
}]}