appfwhtmlerrorpage
Configuration for HTML error page resource.
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| name | <String> | Read-write | Name of the XML error object to remove.
Minimum length = 1
Maximum length = 31
|
| src | <String> | Read-write | URL (protocol, host, path, and name) for the location at which to store the imported HTML error object.
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
|
| comment | <String> | Read-write | Any comments to preserve information about the HTML error object.
Maximum length = 128
|
| overwrite | <Boolean> | Read-write | Overwrite any existing HTML error object of the same name. |
| response | <String> | Read-only | . |
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 Citrix ADC appliance, the URL is as follows:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/login?warning=yesIf 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 Citrix ADC 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 redand placeholder content is marked in <green>.
delete
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/appfwhtmlerrorpage/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 Citrix ADC specific errors). The response payload provides details of the error
Import
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/appfwhtmlerrorpage?action=Import
HTTP Method:POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"appfwhtmlerrorpage":{
<b>"src":<String_value>,
</b><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 Citrix ADC specific errors). The response payload provides details of the error
change
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/appfwhtmlerrorpage?action=update
HTTP Method:POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"appfwhtmlerrorpage":{
<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 Citrix ADC specific errors). The response payload provides details of the error
get (all)
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/appfwhtmlerrorpage
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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:
Content-Type:application/json
Response Payload:
{ "appfwhtmlerrorpage": [ {
"name":<String_value>,
"response":<String_value>,
"src":<String_value>
}]}
get
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/appfwhtmlerrorpage/name_value<String>
Query-parameters:
attrs
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/appfwhtmlerrorpage/name_value<String>?attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
view
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/appfwhtmlerrorpage/name_value<String>?view=summary
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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:
Content-Type:application/json
Response Payload:
{ "appfwhtmlerrorpage": [ {
"name":<String_value>,
"response":<String_value>,
"src":<String_value>
}]}