filterhtmlinjectionparameter¶

Configuration for HTML injection parameter resource.

Properties¶

(click to see Operations )

Name	Data Type	Permissions	Description
rate	<Double>	Read-write	For a rate of x, HTML injection is done for 1 out of x policy matches. Default value: 1 Minimum value = 1
frequency	<Double>	Read-write	For a frequency of x, HTML injection is done at least once per x milliseconds. Default value: 1 Minimum value = 1
strict	<String>	Read-write	Searching for <html> tag. If this parameter is enabled, HTML injection does not insert the prebody or postbody content unless the <html> tag is found. Default value: ENABLED Possible values = ENABLED, DISABLED
htmlsearchlen	<Double>	Read-write	Number of characters, in the HTTP body, in which to search for the <html> tag if strict mode is set. Default value: 1024 Minimum value = 1
builtin	<String[]>	Read-only	Flag to determine if html injection param is built-in or not. Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
feature	<String>	Read-only	The feature to be checked while applying this config.

Operations¶

(click to see Properties )

UPDATE
UNSET
GET (ALL)

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

update¶

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

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"filterhtmlinjectionparameter":{
      "rate":<Double_value>,
      "frequency":<Double_value>,
      "strict":<String_value>,
      "htmlsearchlen":<Double_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

unset¶

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"filterhtmlinjectionparameter":{
      "rate":true,
      "frequency":true,
      "strict":true,
      "htmlsearchlen":true
}}

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

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:

{ "filterhtmlinjectionparameter": [ {
      "rate":<Double_value>,
      "frequency":<Double_value>,
      "strict":<String_value>,
      "htmlsearchlen":<Double_value>,
      "builtin":<String[]_value>,
      "feature":<String_value>
}]}