Download full document:

appfwlearningsettings

Configuration for learning settings resource.

Properties

(click to see Operations)

Name	Data Type	Permissions	Description
profilename	<String>	Read-write	Name of the profile.<br>Minimum length = 1
starturlminthreshold	<Double>	Read-write	Minimum number of application firewall sessions that the learning engine must observe to learn start URLs.<br>Default value: 1<br>Minimum value = 1
starturlpercentthreshold	<Double>	Read-write	Minimum percentage of application firewall sessions that must contain a particular start URL pattern for the learning engine to learn that start URL.<br>Default value: 0<br>Minimum value = 0<br>Maximum value = 100
cookieconsistencyminthreshold	<Double>	Read-write	Minimum number of application firewall sessions that the learning engine must observe to learn cookies.<br>Default value: 1<br>Minimum value = 1
cookieconsistencypercentthreshold	<Double>	Read-write	Minimum percentage of application firewall sessions that must contain a particular cookie pattern for the learning engine to learn that cookie.<br>Default value: 0<br>Minimum value = 0<br>Maximum value = 100
csrftagminthreshold	<Double>	Read-write	Minimum number of application firewall sessions that the learning engine must observe to learn cross-site request forgery (CSRF) tags.<br>Default value: 1<br>Minimum value = 1
csrftagpercentthreshold	<Double>	Read-write	Minimum percentage of application firewall sessions that must contain a particular CSRF tag for the learning engine to learn that CSRF tag.<br>Default value: 0<br>Minimum value = 0<br>Maximum value = 100
fieldconsistencyminthreshold	<Double>	Read-write	Minimum number of application firewall sessions that the learning engine must observe to learn field consistency information.<br>Default value: 1<br>Minimum value = 1
fieldconsistencypercentthreshold	<Double>	Read-write	Minimum percentage of application firewall sessions that must contain a particular field consistency pattern for the learning engine to learn that field consistency pattern.<br>Default value: 0<br>Minimum value = 0<br>Maximum value = 100
crosssitescriptingminthreshold	<Double>	Read-write	Minimum number of application firewall sessions that the learning engine must observe to learn HTML cross-site scripting patterns.<br>Default value: 1<br>Minimum value = 1
crosssitescriptingpercentthreshold	<Double>	Read-write	Minimum percentage of application firewall sessions that must contain a particular cross-site scripting pattern for the learning engine to learn that cross-site scripting pattern.<br>Default value: 0<br>Minimum value = 0<br>Maximum value = 100
sqlinjectionminthreshold	<Double>	Read-write	Minimum number of application firewall sessions that the learning engine must observe to learn HTML SQL injection patterns.<br>Default value: 1<br>Minimum value = 1
sqlinjectionpercentthreshold	<Double>	Read-write	Minimum percentage of application firewall sessions that must contain a particular HTML SQL injection pattern for the learning engine to learn that HTML SQL injection pattern.<br>Default value: 0<br>Minimum value = 0<br>Maximum value = 100
fieldformatminthreshold	<Double>	Read-write	Minimum number of application firewall sessions that the learning engine must observe to learn field formats.<br>Default value: 1<br>Minimum value = 1
fieldformatpercentthreshold	<Double>	Read-write	Minimum percentage of application firewall sessions that must contain a particular web form field pattern for the learning engine to recommend a field format for that form field.<br>Default value: 0<br>Minimum value = 0<br>Maximum value = 100
creditcardnumberminthreshold	<Double>	Read-write	Minimum threshold to learn Credit Card information.<br>Default value: 1<br>Minimum value = 1
creditcardnumberpercentthreshold	<Double>	Read-write	Minimum threshold in percent to learn Credit Card information.<br>Default value: 0<br>Minimum value = 0<br>Maximum value = 100
contenttypeminthreshold	<Double>	Read-write	Minimum threshold to learn Content Type information.<br>Default value: 1<br>Minimum value = 1
contenttypepercentthreshold	<Double>	Read-write	Minimum threshold in percent to learn Content Type information.<br>Default value: 0<br>Minimum value = 0<br>Maximum value = 100
xmlwsiminthreshold	<Double>	Read-write	Minimum number of application firewall sessions that the learning engine must observe to learn web services interoperability (WSI) information.<br>Default value: 1<br>Minimum value = 1
xmlwsipercentthreshold	<Double>	Read-write	Minimum percentage of application firewall sessions that must contain a particular pattern for the learning engine to learn a web services interoperability (WSI) pattern.<br>Default value: 0<br>Minimum value = 0<br>Maximum value = 100
xmlattachmentminthreshold	<Double>	Read-write	Minimum number of application firewall sessions that the learning engine must observe to learn XML attachment patterns.<br>Default value: 1<br>Minimum value = 1
xmlattachmentpercentthreshold	<Double>	Read-write	Minimum percentage of application firewall sessions that must contain a particular XML attachment pattern for the learning engine to learn that XML attachment pattern.<br>Default value: 0<br>Minimum value = 0<br>Maximum value = 100
__count	<Double>	Read-only	count parameter

Operations

(click to see Properties)

UPDATE | UNSET | GET (ALL) | GET | COUNT

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

HTTP Method: PUT

Request Payload:

{
"params": {
      "warning":<String_value>,
      "onerror":<String_value>"
},
sessionid":"##sessionid",
"appfwlearningsettings":{
      "profilename":<String_value>,
      "starturlminthreshold":<Double_value>,
      "starturlpercentthreshold":<Double_value>,
      "cookieconsistencyminthreshold":<Double_value>,
      "cookieconsistencypercentthreshold":<Double_value>,
      "csrftagminthreshold":<Double_value>,
      "csrftagpercentthreshold":<Double_value>,
      "fieldconsistencyminthreshold":<Double_value>,
      "fieldconsistencypercentthreshold":<Double_value>,
      "crosssitescriptingminthreshold":<Double_value>,
      "crosssitescriptingpercentthreshold":<Double_value>,
      "sqlinjectionminthreshold":<Double_value>,
      "sqlinjectionpercentthreshold":<Double_value>,
      "fieldformatminthreshold":<Double_value>,
      "fieldformatpercentthreshold":<Double_value>,
      "creditcardnumberminthreshold":<Double_value>,
      "creditcardnumberpercentthreshold":<Double_value>,
      "contenttypeminthreshold":<Double_value>,
      "contenttypepercentthreshold":<Double_value>,
      "xmlwsiminthreshold":<Double_value>,
      "xmlwsipercentthreshold":<Double_value>,
      "xmlattachmentminthreshold":<Double_value>,
      "xmlattachmentpercentthreshold":<Double_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",
"appfwlearningsettings":{
      "profilename":<String_value>,
      "starturlminthreshold":true,
      "starturlpercentthreshold":true,
      "cookieconsistencyminthreshold":true,
      "cookieconsistencypercentthreshold":true,
      "csrftagminthreshold":true,
      "csrftagpercentthreshold":true,
      "fieldconsistencyminthreshold":true,
      "fieldconsistencypercentthreshold":true,
      "crosssitescriptingminthreshold":true,
      "crosssitescriptingpercentthreshold":true,
      "sqlinjectionminthreshold":true,
      "sqlinjectionpercentthreshold":true,
      "fieldformatminthreshold":true,
      "fieldformatpercentthreshold":true,
      "creditcardnumberminthreshold":true,
      "creditcardnumberpercentthreshold":true,
      "contenttypeminthreshold":true,
      "contenttypepercentthreshold":true,
      "xmlwsiminthreshold":true,
      "xmlwsipercentthreshold":true,
      "xmlattachmentminthreshold":true,
      "xmlattachmentpercentthreshold":true,
}}

Response Payload:

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

get (all)

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

Query-parameters:

filter

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

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

view

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

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

pagesize=#no;pageno=#no

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

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

warning

http://<NS_IP>/nitro/v1/config/appfwlearningsettings?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>, "appfwlearningsettings": [ {
      "profilename":<String_value>,
      "starturlminthreshold":<Double_value>,
      "starturlpercentthreshold":<Double_value>,
      "cookieconsistencyminthreshold":<Double_value>,
      "cookieconsistencypercentthreshold":<Double_value>,
      "csrftagminthreshold":<Double_value>,
      "csrftagpercentthreshold":<Double_value>,
      "fieldconsistencyminthreshold":<Double_value>,
      "fieldconsistencypercentthreshold":<Double_value>,
      "crosssitescriptingminthreshold":<Double_value>,
      "crosssitescriptingpercentthreshold":<Double_value>,
      "sqlinjectionminthreshold":<Double_value>,
      "sqlinjectionpercentthreshold":<Double_value>,
      "fieldformatminthreshold":<Double_value>,
      "fieldformatpercentthreshold":<Double_value>,
      "creditcardnumberminthreshold":<Double_value>,
      "creditcardnumberpercentthreshold":<Double_value>,
      "contenttypeminthreshold":<Double_value>,
      "contenttypepercentthreshold":<Double_value>,
      "xmlwsiminthreshold":<Double_value>,
      "xmlwsipercentthreshold":<Double_value>,
      "xmlattachmentminthreshold":<Double_value>,
      "xmlattachmentpercentthreshold":<Double_value>

}]}

get

URL: http://<NS_IP>/nitro/v1/config/appfwlearningsettings/profilename_value<String>

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "appfwlearningsettings": [ {
      "profilename":<String_value>,
      "starturlminthreshold":<Double_value>,
      "starturlpercentthreshold":<Double_value>,
      "cookieconsistencyminthreshold":<Double_value>,
      "cookieconsistencypercentthreshold":<Double_value>,
      "csrftagminthreshold":<Double_value>,
      "csrftagpercentthreshold":<Double_value>,
      "fieldconsistencyminthreshold":<Double_value>,
      "fieldconsistencypercentthreshold":<Double_value>,
      "crosssitescriptingminthreshold":<Double_value>,
      "crosssitescriptingpercentthreshold":<Double_value>,
      "sqlinjectionminthreshold":<Double_value>,
      "sqlinjectionpercentthreshold":<Double_value>,
      "fieldformatminthreshold":<Double_value>,
      "fieldformatpercentthreshold":<Double_value>,
      "creditcardnumberminthreshold":<Double_value>,
      "creditcardnumberpercentthreshold":<Double_value>,
      "contenttypeminthreshold":<Double_value>,
      "contenttypepercentthreshold":<Double_value>,
      "xmlwsiminthreshold":<Double_value>,
      "xmlwsipercentthreshold":<Double_value>,
      "xmlattachmentminthreshold":<Double_value>,
      "xmlattachmentpercentthreshold":<Double_value>

}]}

count

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

HTTP Method: GET

Response Payload:

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