appfwlearningdata¶

Configuration for learning data resource.

Properties¶

(click to see Operations )

Name	Data Type	Permissions	Description
profilename	<String>	Read-write	Name of the profile.
starturl	<String>	Read-write	Start URL configuration. Minimum length = 1
cookieconsistency	<String>	Read-write	Cookie Name. Minimum length = 1
fieldconsistency	<String>	Read-write	Form field name. Minimum length = 1
formactionurl_ffc	<String>	Read-write	Form action URL.
contenttype	<String>	Read-write	Content Type Name. Minimum length = 1
crosssitescripting	<String>	Read-write	Cross-site scripting. Minimum length = 1
formactionurl_xss	<String>	Read-write	Form action URL. Minimum length = 1
as_scan_location_xss	<String>	Read-write	Location of cross-site scripting exception - form field, header, cookie or url. Possible values = FORMFIELD, HEADER, COOKIE, URL
as_value_type_xss	<String>	Read-write	XSS value type. (Tag \| Attribute \| Pattern). Possible values = Tag, Attribute, Pattern
as_value_expr_xss	<String>	Read-write	XSS value expressions consistituting expressions for Tag, Attribute or Pattern.
sqlinjection	<String>	Read-write	Form field name. Minimum length = 1
formactionurl_sql	<String>	Read-write	Form action URL. Minimum length = 1
as_scan_location_sql	<String>	Read-write	Location of sql injection exception - form field, header or cookie. Possible values = FORMFIELD, HEADER, COOKIE
as_value_type_sql	<String>	Read-write	SQL value type. Keyword, SpecialString or Wildchar. Possible values = Keyword, SpecialString, Wildchar
as_value_expr_sql	<String>	Read-write	SQL value expressions consistituting expressions for Keyword, SpecialString or Wildchar.
fieldformat	<String>	Read-write	Field format name. Minimum length = 1
formactionurl_ff	<String>	Read-write	Form action URL. Minimum length = 1
csrftag	<String>	Read-write	CSRF Form Action URL. Minimum length = 1
csrfformoriginurl	<String>	Read-write	CSRF Form Origin URL. Minimum length = 1
creditcardnumber	<String>	Read-write	The object expression that is to be excluded from safe commerce check. Minimum length = 1
creditcardnumberurl	<String>	Read-write	The url for which the list of credit card numbers are needed to be bypassed from inspection. Minimum length = 1
xmldoscheck	<String>	Read-write	XML Denial of Service check, one of MaxAttributes MaxAttributeNameLength MaxAttributeValueLength MaxElementNameLength MaxFileSize MinFileSize MaxCDATALength MaxElements MaxElementDepth MaxElementChildren NumDTDs NumProcessingInstructions NumExternalEntities MaxEntityExpansions MaxEntityExpansionDepth MaxNamespaces MaxNamespaceUriLength MaxSOAPArraySize MaxSOAPArrayRank . Minimum length = 1
xmlwsicheck	<String>	Read-write	Web Services Interoperability Rule ID. Minimum length = 1
xmlattachmentcheck	<String>	Read-write	XML Attachment Content-Type. Minimum length = 1
totalxmlrequests	<Boolean>	Read-write	Total XML requests.
securitycheck	<String>	Read-write	Name of the security check. Possible values = startURL, cookieConsistency, fieldConsistency, crossSiteScripting, SQLInjection, fieldFormat, CSRFtag, XMLDoSCheck, XMLWSICheck, XMLAttachmentCheck, TotalXMLRequests, creditCardNumber, ContentType
target	<String>	Read-write	Target filename for data to be exported. Minimum length = 1 Maximum length = 127
url	<String>	Read-only	Learnt url.
name	<String>	Read-only	Learnt field name.
fieldtype	<String>	Read-only	Learnt field type.
fieldformatminlength	<Double>	Read-only	The minimum allowed length for data in this form field.
fieldformatmaxlength	<Double>	Read-only	The maximum allowed length for data in this form field.
fieldformatcharmappcre	<String>	Read-only	Form field value allowed character map.
value_type	<String>	Read-only	Learnt field value type.
value	<String>	Read-only	Learnt field value.
hits	<Double>	Read-only	Learnt entity hit count.
data	<String>	Read-only	Learned data.
__count	<Double>	Read-only	count parameter

Operations¶

(click to see Properties )

DELETE
GET (ALL)
COUNT
RESET
EXPORT

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

delete¶

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

Query-parameters:

args= profilename:<String_value>, starturl: <String_value> ,cookieconsistency: <String_value> ,fieldconsistency: <String_value> ,formactionurl_ffc: <String_value> ,contenttype: <String_value> ,crosssitescripting: <String_value> ,formactionurl_xss: <String_value> ,as_scan_location_xss: <String_value> ,as_value_type_xss: <String_value> ,as_value_expr_xss: <String_value> ,sqlinjection: <String_value> ,formactionurl_sql: <String_value> ,as_scan_location_sql: <String_value> ,as_value_type_sql: <String_value> ,as_value_expr_sql: <String_value> ,fieldformat: <String_value> ,formactionurl_ff: <String_value> ,csrftag: <String_value> ,csrfformoriginurl: <String_value> ,creditcardnumber: <String_value> ,creditcardnumberurl: <String_value> ,xmldoscheck: <String_value> ,xmlwsicheck: <String_value> ,xmlattachmentcheck: <String_value> ,totalxmlrequests: <Boolean_value>

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

reset¶

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"appfwlearningdata":{
}}

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

export¶

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"appfwlearningdata":{
<b>      "profilename":<String_value>,
</b><b>      "securitycheck":<String_value>,
</b>      "target":<String_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

get (all)¶

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

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/config/appfwlearningdata? args= profilename:<String_value>, securitycheck:<String_value>,

Use this query-parameter to get appfwlearningdata resources based on additional properties.

attrs

http:// <netscaler-ip-address> /nitro/v1/config/appfwlearningdata? 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/appfwlearningdata? filter=property-name1:property-val1,property-name2:property-val2

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

view

http:// <netscaler-ip-address> /nitro/v1/config/appfwlearningdata? view=summary

Use this query-parameter to get the summary output of appfwlearningdata 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/appfwlearningdata? pagesize=#no;pageno=#no

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

{ "appfwlearningdata": [ {
<b>profilename:<String_value>,</b><b>securitycheck:<String_value>,</b>      "url":<String_value>,
      "name":<String_value>,
      "fieldtype":<String_value>,
      "fieldformatminlength":<Double_value>,
      "fieldformatmaxlength":<Double_value>,
      "fieldformatcharmappcre":<String_value>,
      "value_type":<String_value>,
      "value":<String_value>,
      "hits":<Double_value>,
      "data":<String_value>
}]}

count¶

URL: http:// <netscaler-ip-address> /nitro/v1/config/appfwlearningdata? args= profilename:<String_value>, securitycheck:<String_value>, ;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:

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