Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

responderaction

August 17, 2023
Contributed by: 
C

Configuration for responder action resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
name 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 Citrix ADC 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 Read-write Type of responder action. Available settings function as follows
  • respondwith - 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. Possible values = noop, respondwith, redirect, respondwithhtmlpage, sqlresponse_ok, sqlresponse_error
    		•
    target Read-write Expression specifying what to respond with. Typically a URL for redirect policies or a default-syntax expression. In addition to Citrix ADC 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 Citrix ADC 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 Citrix ADC CLI Enclose the entire expression in single quotation marks. (Citrix ADC 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 Read-write For respondwithhtmlpage policies, name of the HTML page object to use as the response. You must first import the page object.

    Minimum length = 1
    bypasssafetycheck 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.

    Default value: NO

    Possible values = YES, NO
    comment Read-write Comment. Any type of information about this responder action.
    responsestatuscode Read-write HTTP response status code, for example 200, 302, 404, etc. The default value for the redirect action type is 302 and for respondwithhtmlpage is 200.

    Minimum value = 100

    Maximum value = 599
    reasonphrase Read-write Expression specifying the reason phrase of the HTTP response. The reason phrase may be a string literal with quotes or a PI expression. For example: “Invalid URL: “ + HTTP.REQ.URL.

    Minimum length = 1
    headers <String[]> Read-write One or more headers to insert into the HTTP response. Each header is specified as “name(expr)”, where expr is an expression that is evaluated at runtime to provide the value for the named header. You can configure a maximum of eight headers for a responder action.
    newname 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 Citrix ADC 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’). Minimum length = 1
    hits Read-only The number of times the action has been taken.
    referencecount Read-only The number of references to the action.
    undefhits 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.

    Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
    feature Read-only The feature to be checked while applying this config.
    __count Read-only count parameter

    Operations

    (click to see Properties )

    • ADD
    • DELETE
    • UPDATE
    • UNSET
    • GET (ALL)
    • GET
    • COUNT
    • RENAME

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

    HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    
{"responderaction":{
<b>      "name":<String_value>,
</b><b>      "type":<String_value>,
</b>      "target":<String_value>,
      "htmlpage":<String_value>,
      "bypasssafetycheck":<String_value>,
      "comment":<String_value>,
      "responsestatuscode":<Double_value>,
      "reasonphrase":<String_value>,
      "headers":<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/responderaction/ 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

    update

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

    HTTP Method: PUT

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    
{"responderaction":{
<b>      "name":<String_value>,
</b>      "target":<String_value>,
      "bypasssafetycheck":<String_value>,
      "htmlpage":<String_value>,
      "responsestatuscode":<Double_value>,
      "reasonphrase":<String_value>,
      "comment":<String_value>,
      "headers":<String[]_value>
}}

<!--NeedCopy-->

    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

    unset

    URL: http:// <netscaler-ip-address> /nitro/v1/config/responderaction? action=unset

    HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    
{"responderaction":{
<b>      "name":<String_value>,
</b>      "responsestatuscode":true,
      "reasonphrase":true,
      "comment":true,
      "headers":true
}}

<!--NeedCopy-->

    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

    rename

    URL: http:// <netscaler-ip-address> /nitro/v1/config/responderaction? action=rename

    HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    
{"responderaction":{
<b>      "name":<String_value>,
</b><b>      "newname":<String_value>
</b>}}

<!--NeedCopy-->

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

    Query-parameters:

    attrs

    http:// <netscaler-ip-address> /nitro/v1/config/responderaction? attrs=property-name1,property-name2

    Use this query parameter to specify the resource details that you want to retrieve.

    filter

    http:// <netscaler-ip-address> /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:// <netscaler-ip-address> /nitro/v1/config/responderaction? view=summary

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

    Note: By default, the retrieved results are displayed in detail view (?view=detail).

    pagination

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

    Use this query-parameter to get the responderaction 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: 

    
{ "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>,
      "feature":<String_value>,
      "responsestatuscode":<Double_value>,
      "reasonphrase":<String_value>,
      "headers":<String[]_value>
}]}

<!--NeedCopy-->

    get

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

    Query-parameters:

    attrs

    http:// <netscaler-ip-address> /nitro/v1/config/responderaction/ 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/responderaction/ name_value<String> ? view=summary

    Use this query-parameter to get the summary output of responderaction 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: 

    
{  "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>,
      "feature":<String_value>,
      "responsestatuscode":<Double_value>,
      "reasonphrase":<String_value>,
      "headers":<String[]_value>
}]}

<!--NeedCopy-->

    count

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

    
{ "responderaction": [ { "__count": "#no"} ] }

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