Developer Documentation
ADM NITRO APIs

security_app_dashboard_details

June 20, 2023
Contributed by: 
C

Configuration for Security App Dashboard Report table resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
violation_category Read-write violation Category..
app_threat_index Read-write Application threat Index.
ns_city Read-write Citrix ADC Location city.
severity_type Read-write severity_type.

Maximum length = 255
__count Read-write count..
app_category Read-write App Category.

Maximum length = 255
country_code Read-write country_code.

Maximum length = 255
violation_type Read-write Violation Type.
block_flags_prev Read-write Block flag count.
safety_index Read-write safety index..
source_ip_address_prev Read-write Client ip address.

Maximum length = 255
app_safety_index_prev Read-write App safety index prev.
appname Read-write AppName.

Maximum length = 255
threat_index Read-write threat_index.
city Read-write city.
total_attacks_prev Read-write Count of attacks in given sampled timeframe..
latitude Read-write latitude.
ctnsappname Read-write AppName.

Maximum length = 255
ip_address Read-write Citrix ADC IP Address..

Minimum length = 1

Maximum length = 64
app_safety_index Read-write App Safety Index.
country Read-write country.

Maximum length = 255
longitude Read-write longitude.
source_ip_address Read-write Client ip address.

Maximum length = 255
name Read-write Name of Citrix ADC Instance.

Minimum length = 1

Maximum length = 128
rpt_sample_time Read-write Report Sample time..
description Read-write Violation Type Description.
total_attacks Read-write Count of this URL in given sampled timeframe..
device_ip_address Read-write Device IP Address.

Maximum length = 255
attack_category Read-write Attack Category..
ns_latitude Read-write Citrix ADC Location latitude.
exporter_id Read-write Exporter ID.

Maximum length = 255
vserver_name Read-write AppName.

Maximum length = 255
ns_longitude Read-write Citrix ADC Location longitude.
app_threat_index_prev Read-write App threat index previous.
block_flags Read-write Block flag count.

Operations

(click to see Properties )

  • 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 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/security_app_dashboard_details Query-parameters:

order_by Use this query-parameter to get the result that is ordered by the given property.

Possible Values: total_attacks, app_threat_index group_by Use this query-parameter to get the result that is grouped by according to the given property.

Possible Values: violation_type, rpt_sample_time HTTPS Method: GET

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, "security_app_dashboard_details":[{
"violation_category":<String_value>,
"app_threat_index":<Double_value>,
"ns_city":<String_value>,
"severity_type":<String_value>,
"__count":<Double_value>,
"app_category":<String_value>,
"country_code":<String_value>,
"violation_type":<String_value>,
"block_flags_prev":<Double_value>,
"safety_index":<Double_value>,
"source_ip_address_prev":<String_value>,
"app_safety_index_prev":<Double_value>,
"appname":<String_value>,
"threat_index":<Double_value>,
"city":<String_value>,
"total_attacks_prev":<Double_value>,
"latitude":<Double_value>,
"ctnsappname":<String_value>,
"ip_address":<String_value>,
"app_safety_index":<Double_value>,
"country":<String_value>,
"longitude":<Double_value>,
"source_ip_address":<String_value>,
"name":<String_value>,
"rpt_sample_time":<Double_value>,
"description":<String_value>,
"total_attacks":<Double_value>,
"device_ip_address":<String_value>,
"attack_category":<String_value>,
"ns_latitude":<Double_value>,
"exporter_id":<String_value>,
"vserver_name":<String_value>,
"ns_longitude":<Double_value>,
"app_threat_index_prev":<Double_value>,
"block_flags":<Double_value>}]}

<!--NeedCopy-->
security_app_dashboard_details
June 20, 2023
Contributed by: 
C
June 20, 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.