Download full document:

responderhtmlpage

Configuration for Responder HTML page resource.

Properties

(click to see Operations)

Name Data Type PermissionsDescription
src<String>Read-writeLocal path to and name of, or URL \\(protocol, host, path, and file name\\) for, the file in which to store the imported HTML page. NOTE: The import fails if the object to be imported is on an HTTPS server that requires client certificate authentication for access.<br>Minimum length = 1<br>Maximum length = 2047
name<String>Read-writeName to assign to the HTML page object on the NetScaler appliance.<br>Minimum length = 1<br>Maximum length = 31
comment<String>Read-writeAny comments to preserve information about the HTML page object.<br>Maximum length = 128
overwrite<Boolean>Read-writeOverwrites 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://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload: 

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "action":"Import"
},
"sessionid":"##sessionid",
"responderhtmlpage":{
      "src":<String_value>,
      "name":<String_value>,
      "comment":<String_value>,
      "overwrite":<Boolean_value>,
}}

Response Payload:

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

delete

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

Query-parameters:

warning

http://<NS_IP>/nitro/v1/config/responderhtmlpage/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": }

change

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

HTTP Method: POST

Request Payload: 

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "action":"update"
},
"sessionid":"##sessionid",
"responderhtmlpage":{
      "name":<String_value>,
}}

Response Payload:

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

get (all)

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

HTTP Method: GET

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "responderhtmlpage": [ {
      "name":<String_value>,
      "response":<String_value>

}]}

get

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

HTTP Method: GET

Response Payload: 

{ "errorcode": 0, "message": "Done", "responderhtmlpage": [ {
      "name":<String_value>,
      "response":<String_value>

}]}