Download full document:

responderaction

Configuration for responder action resource.

Properties

(click to see Operations)

Name	Data Type	Permissions	Description
name	<String>	Read-write	Name for the responder action. Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) hash (#), space ( ), at (@), equals (=), colon (:), and underscore characters. Can be changed after the responder policy is added. The following requirement applies only to the NetScaler CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my responder action" or my responder action).
type	<String>	Read-write	Type of responder action. Available settings function as follows: * respondwith ;lt;target;gt; - Respond to the request with the expression specified as the target. * respondwithhtmlpage - Respond to the request with the uploaded HTML page object specified as the target. * redirect - Redirect the request to the URL specified as the target. * sqlresponse_ok - Send an SQL OK response. * sqlresponse_error - Send an SQL ERROR response.<br>Possible values = noop, respondwith, redirect, respondwithhtmlpage, sqlresponse_ok, sqlresponse_error
target	<String>	Read-write	Expression specifying what to respond with. Typically a URL for redirect policies or a default-syntax expression. In addition to NetScaler default-syntax expressions that refer to information in the request, a stringbuilder expression can contain text and HTML, and simple escape codes that define new lines and paragraphs. Enclose each stringbuilder expression element (either a NetScaler default-syntax expression or a string) in double quotation marks. Use the plus (+) character to join the elements. Examples: 1) Respondwith expression that sends an HTTP 1.1 200 OK response: "HTTP/1.1 200 OK\\r\\n\\r\\n" 2) Redirect expression that redirects user to the specified web host and appends the request URL to the redirect. "http://backupsite2.com" + HTTP.REQ.URL 3) Respondwith expression that sends an HTTP 1.1 404 Not Found response with the request URL included in the response: "HTTP/1.1 404 Not Found\\r\\n\\r\\n"+ "HTTP.REQ.URL.HTTP_URL_SAFE" + "does not exist on the web server." The following requirement applies only to the NetScaler CLI: Enclose the entire expression in single quotation marks. (NetScaler default expression elements should be included inside the single quotation marks for the entire expression, but do not need to be enclosed in double quotation marks.).
htmlpage	<String>	Read-write	For respondwithhtmlpage policies, name of the HTML page object to use as the response. You must first import the page object.<br>Minimum length = 1
bypasssafetycheck	<String>	Read-write	Bypass the safety check, allowing potentially unsafe expressions. An unsafe expression in a response is one that contains references to request elements that might not be present in all requests. If a response refers to a missing request element, an empty string is used instead.<br>Default value: NO<br>Possible values = YES, NO
comment	<String>	Read-write	Comment. Any type of information about this responder action.
newname	<String>	Read-write	New name for the responder action. Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) hash (#), space ( ), at (@), equals (=), colon (:), and underscore characters. The following requirement applies only to the NetScaler CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my responder action" or my responder action).<br>Minimum length = 1
hits	<Double>	Read-only	The number of times the action has been taken.
referencecount	<Double>	Read-only	The number of references to the action.
undefhits	<Double>	Read-only	The number of times the action resulted in UNDEF.
builtin	<String[]>	Read-only	Flag to determine whether responder action is built-in or not.<br>Possible values = MODIFIABLE, DELETABLE, IMMUTABLE
__count	<Double>	Read-only	count parameter

Operations

(click to see Properties)

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://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload:

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>
},
"sessionid":"##sessionid",
"responderaction":{
      "name":<String_value>,
      "type":<String_value>,
      "target":<String_value>,
      "htmlpage":<String_value>,
      "bypasssafetycheck":<String_value>,
      "comment":<String_value>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

delete

URL: http://<NSIP>/nitro/v1/config/responderaction/name_value<String>

Query-parameters:

warning

http://<NS_IP>/nitro/v1/config/responderaction/name_value<String>?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: DELETE

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

update

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: PUT

Request Payload:

{
"params": {
      "warning":<String_value>,
      "onerror":<String_value>"
},
sessionid":"##sessionid",
"responderaction":{
      "name":<String_value>,
      "target":<String_value>,
                  "bypasssafetycheck":<String_value>,
      "htmlpage":<String_value>,
      "comment":<String_value>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

unset

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload:

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "action":"unset"
},
"sessionid":"##sessionid",
"responderaction":{
      "name":<String_value>,
      "comment":true,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

rename

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload:

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "action":"rename"
},
"sessionid":"##sessionid",
"responderaction":{
      "name":<String_value>,
      "newname":<String_value>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

get (all)

URL: http://<NSIP>/nitro/v1/config/responderaction

Query-parameters:

filter

http://<NSIP>/nitro/v1/config/responderaction?filter=property-name1:property-val1,property-name2:property-val2

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

view

http://<NS_IP>/nitro/v1/config/responderaction?view=summary

Use this query-parameter to get the summary output of responderaction resources configured on NetScaler.

pagesize=#no;pageno=#no

http://<NS_IP>/nitro/v1/config/responderaction?pagesize=#no;pageno=#no

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

warning

http://<NS_IP>/nitro/v1/config/responderaction?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "responderaction": [ {
      "name":<String_value>,
      "type":<String_value>,
      "target":<String_value>,
      "htmlpage":<String_value>,
      "bypasssafetycheck":<String_value>,
      "hits":<Double_value>,
      "referencecount":<Double_value>,
      "undefhits":<Double_value>,
      "comment":<String_value>,
      "builtin":<String[]_value>

}]}

get

URL: http://<NS_IP>/nitro/v1/config/responderaction/name_value<String>

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "responderaction": [ {
      "name":<String_value>,
      "type":<String_value>,
      "target":<String_value>,
      "htmlpage":<String_value>,
      "bypasssafetycheck":<String_value>,
      "hits":<Double_value>,
      "referencecount":<Double_value>,
      "undefhits":<Double_value>,
      "comment":<String_value>,
      "builtin":<String[]_value>

}]}

count

URL: http://<NS_IP>/nitro/v1/config/responderaction?count=yes

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done",responderaction: [ { "__count": "#no"} ] }