Developer Documentation
Citrix ADC 12.1 NITRO API Reference
Current Release 13.1 13

appfwlearningsettings

August 17, 2023
Contributed by: 
C

Configuration for learning settings resource.

Properties

(click to see Operations)

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

    http://<Citrix-ADC-IP-address(NSIP)>/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 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>.

update

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/appfwlearningsettings

HTTP Method:PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload: 


{"appfwlearningsettings":{
<b>"profilename":<String_value>,
</b>"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>
}}

<!--NeedCopy-->

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

unset

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/appfwlearningsettings?action=unset

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload: 


{"appfwlearningsettings":{
<b>"profilename":<String_value>,
</b>"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
}}

<!--NeedCopy-->

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

Query-parameters:

attrs

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/appfwlearningsettings?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http://<Citrix-ADC-IP-address(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 Citrix ADC. Filtering can be done on any of the properties of the resource.

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/appfwlearningsettings?view=summary

Note:By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/appfwlearningsettings?pagesize=#no;pageno=#no

Use this query-parameter to get the appfwlearningsettings 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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload: 


{ "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>
}]}

<!--NeedCopy-->

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/appfwlearningsettings/profilename_value<String>

Query-parameters:

attrs

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/appfwlearningsettings/profilename_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/appfwlearningsettings/profilename_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: 


{ "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>
}]}

<!--NeedCopy-->

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/appfwlearningsettings?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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload: 


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

<!--NeedCopy-->
appfwlearningsettings
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.