Citrix ADM NITRO API Reference

waf_security_settings

June 20, 2023

Contributed by:

Configuration for Mapping Learning group with Learning settings resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
parent_name	<String>	Read-write	Resource name of parent resource.
configured_grace_period	<Double>	Read-write	time before a rule is auto deployed.
configured_time_window	<Double>	Read-write	time duration in seconds for which a rule's hit are accounted for in rule removal.
parent_id	<String>	Read-write	Id of the parent resource.
is_autodeploy	<Boolean>	Read-write	when TRUE ADM will deploy if user does not respond to alerts.
configured_threshold	<Double>	Read-write	the number of times a violation needs to occur for it to be ready to be deployed.
violation_name	<String>	Read-write	violation name used for each violation id. Maximum length = 512
id	<String>	Read-write	Id is system generated key for WAF Profile - ADC map.
violation_id	<Integer>	Read-write	ADC WAF Security checks have unique ID i.e violation_id.
check_type	<Integer>	Read-write	Check type can be WAF Profile name based (0), Application name based (1), Rule removal (2) .
enabled	<Boolean>	Read-write	TRUE when this Security check is enabled for Learning.

Operations

(click to see Properties )

GET (ALL)
GET
UPDATE

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

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/waf_security_settings Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/waf_security_settings ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of waf_security_settings resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/waf_security_settings ?pagesize=#no;pageno=#no Use this query-parameter to get the waf_security_settings resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/waf_security_settings ?count=yes Use this query-parameter to get the count of waf_security_settings resources.

HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "waf_security_settings":[{
"parent_name":<String_value>,
"configured_grace_period":<Double_value>,
"configured_time_window":<Double_value>,
"parent_id":<String_value>,
"is_autodeploy":<Boolean_value>,
"configured_threshold":<Double_value>,
"violation_name":<String_value>,
"id":<String_value>,
"violation_id":<Integer_value>,
"check_type":<Integer_value>,
"enabled":<Boolean_value>}]}

<!--NeedCopy-->

get

URL: https://<MGMT-IP>/nitro/v2/config/waf_security_settings/id_value<String> HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "waf_security_settings":[{
"parent_name":<String_value>,
"configured_grace_period":<Double_value>,
"configured_time_window":<Double_value>,
"parent_id":<String_value>,
"is_autodeploy":<Boolean_value>,
"configured_threshold":<Double_value>,
"violation_name":<String_value>,
"id":<String_value>,
"violation_id":<Integer_value>,
"check_type":<Integer_value>,
"enabled":<Boolean_value>}]}

<!--NeedCopy-->

update

URL: https://<MGMT-IP>/nitro/v2/config/waf_security_settings/id_value<String> HTTPS Method: PUT

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"waf_security_settings":{
"violation_id":<Integer_value>,
"enabled":<Boolean_value>,
"check_type":<Integer_value>,
"configured_time_window":<Double_value>,
"violation_name":<String_value>,
"configured_grace_period":<Double_value>,
"parent_id":<String_value>,
"configured_threshold":<Double_value>,
"is_autodeploy":<Boolean_value>,
"id":<String_value>,
"parent_name":<String_value>}}

<!--NeedCopy-->

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "waf_security_settings":[{
"parent_name":<String_value>,
"configured_grace_period":<Double_value>,
"configured_time_window":<Double_value>,
"parent_id":<String_value>,
"is_autodeploy":<Boolean_value>,
"configured_threshold":<Double_value>,
"violation_name":<String_value>,
"id":<String_value>,
"violation_id":<Integer_value>,
"check_type":<Integer_value>,
"enabled":<Boolean_value>}]}

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

waf_security_settings

June 20, 2023

Contributed by:

June 20, 2023

Contributed by:

waf_security_settings

Properties

Operations

get (all)

get

update

In this article