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

appfwsettings

August 17, 2023
Contributed by: 
C

Configuration for AS settings resource.

Properties

(click to see Operations)

Name Data Type Permissions Description
defaultprofile Read-write Profile to use when a connection does not match any policy. Default setting is APPFW_BYPASS, which sends unmatched connections back to the Citrix ADC without attempting to filter them further.
Default value: APPFW_BYPASS
Minimum length = 1
undefaction Read-write Profile to use when an application firewall policy evaluates to undefined (UNDEF).
An UNDEF event indicates an internal error condition. The APPFW_BLOCK built-in profile is the default setting. You can specify a different built-in or user-created profile as the UNDEF profile.
Default value: APPFW_BLOCK
Minimum length = 1
sessiontimeout Read-write Timeout, in seconds, after which a user session is terminated. Before continuing to use the protected web site, the user must establish a new session by opening a designated start URL.
Default value: 900
Minimum value = 1
Maximum value = 65535
learnratelimit Read-write Maximum number of connections per second that the application firewall learning engine examines to generate new relaxations for learning-enabled security checks. The application firewall drops any connections above this limit from the list of connections used by the learning engine.
Default value: 400
Minimum value = 1
Maximum value = 1000
sessionlifetime Read-write Maximum amount of time (in seconds) that the application firewall allows a user session to remain active, regardless of user activity. After this time, the user session is terminated. Before continuing to use the protected web site, the user must establish a new session by opening a designated start URL.
Default value: 0
Minimum value = 0
Maximum value = 2147483647
sessioncookiename Read-write Name of the session cookie that the application firewall uses to track user sessions.
Must begin with a letter or number, and can consist of from 1 to 31 letters, numbers, and the hyphen (-) and underscore (_) symbols.

The following requirement applies only to the Citrix ADC CLI:
If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my cookie name” or ‘my cookie name’).
Minimum length = 1
clientiploggingheader Read-write Name of an HTTP header that contains the IP address that the client used to connect to the protected web site or service.
importsizelimit Read-write Cumulative total maximum number of bytes in web forms imported to a protected web site. If a user attempts to upload files with a total byte count higher than the specified limit, the application firewall blocks the request.
Default value: 134217728
Minimum value = 1
Maximum value = 268435456
signatureautoupdate Read-write Flag used to enable/disable auto update signatures.
Default value: OFF
Possible values = ON, OFF
signatureurl Read-write URL to download the mapping file from server.
Default value: https://s3.amazonaws.com/NSAppFwSignatures/SignaturesMapping.xml
cookiepostencryptprefix Read-write String that is prepended to all encrypted cookie values.
Minimum length = 1
logmalformedreq Read-write Log requests that are so malformed that application firewall parsing doesn’t occur.
Default value: ON
Possible values = ON, OFF
geolocationlogging Read-write Enable Geo-Location Logging in CEF format logs.
Default value: OFF
Possible values = ON, OFF
ceflogging Read-write Enable CEF format logs.
Default value: OFF
Possible values = ON, OFF
entitydecoding Read-write Transform multibyte (double- or half-width) characters to single width characters.
Default value: OFF
Possible values = ON, OFF
useconfigurablesecretkey Read-write Use configurable secret key in AppFw operations.
Default value: OFF
Possible values = ON, OFF
sessionlimit Read-write Maximum number of sessions that the application firewall allows to be active, regardless of user activity. After the max_limit reaches, No more user session will be created .
Default value: 100000
Minimum value = 0
Maximum value = 500000
malformedreqaction <String[]> Read-write flag to define action on malformed requests that application firewall cannot parse.
Possible values = none, block, log, stats

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

HTTP Method:PUT

Request Headers:

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

Request Payload: 


{"appfwsettings":{
"defaultprofile":<String_value>,
"undefaction":<String_value>,
"sessiontimeout":<Double_value>,
"learnratelimit":<Double_value>,
"sessionlifetime":<Double_value>,
"sessioncookiename":<String_value>,
"clientiploggingheader":<String_value>,
"importsizelimit":<Double_value>,
"signatureautoupdate":<String_value>,
"signatureurl":<String_value>,
"cookiepostencryptprefix":<String_value>,
"logmalformedreq":<String_value>,
"geolocationlogging":<String_value>,
"ceflogging":<String_value>,
"entitydecoding":<String_value>,
"useconfigurablesecretkey":<String_value>,
"sessionlimit":<Double_value>,
"malformedreqaction":<String[]_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/appfwsettings?action=unset

HTTP Method:POST

Request Headers:

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

Request Payload: 


{"appfwsettings":{
"defaultprofile":true,
"undefaction":true,
"sessiontimeout":true,
"learnratelimit":true,
"sessionlifetime":true,
"sessioncookiename":true,
"clientiploggingheader":true,
"importsizelimit":true,
"signatureautoupdate":true,
"signatureurl":true,
"cookiepostencryptprefix":true,
"logmalformedreq":true,
"geolocationlogging":true,
"ceflogging":true,
"entitydecoding":true,
"useconfigurablesecretkey":true,
"sessionlimit":true,
"malformedreqaction":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/appfwsettings

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: 


{ "appfwsettings": [ {
"defaultprofile":<String_value>,
"undefaction":<String_value>,
"sessiontimeout":<Double_value>,
"learnratelimit":<Double_value>,
"sessionlifetime":<Double_value>,
"sessioncookiename":<String_value>,
"clientiploggingheader":<String_value>,
"importsizelimit":<Double_value>,
"signatureautoupdate":<String_value>,
"signatureurl":<String_value>,
"cookiepostencryptprefix":<String_value>,
"logmalformedreq":<String_value>,
"geolocationlogging":<String_value>,
"ceflogging":<String_value>,
"entitydecoding":<String_value>,
"useconfigurablesecretkey":<String_value>,
"sessionlimit":<Double_value>,
"malformedreqaction":<String[]_value>
}]}

<!--NeedCopy-->
appfwsettings
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.