Developer Documentation
Citrix ADM NITRO API Reference

si_security_overview

June 20, 2023
Contributed by: 
C

Configuration for AF Data Report table resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
severity_type Read-write severity_type.

Maximum length = 255
threat_index Read-write Threat Index.
name Read-write AppName.

Maximum length = 255
not_compliant_percentage Read-write not_compliant_percentage.
si_app_unit_name Read-write AppName.

Maximum length = 255
__count Read-write Number of records.
not_compliant_count Read-write Not Compliant Count.
id Read-write Id is Security check violation name.

Maximum length = 255
safety_index Read-write safety index.
total_compliant_count Read-write Total Compliant Count.
total_attacks Read-write Total Attacks..

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

report_start_time Use this query-parameter to specify the start time from which the summary for report is considered.

Possible Values: time in milli seconds report_end_time Use this query-parameter to specify the end time until where summary for report is considered.

Possible Values: time in milli seconds order_by Use this query-parameter to get the result that is ordered by the given property.

Possible Values: ctnsappname 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, "si_security_overview":[{
"severity_type":<String_value>,
"threat_index":<Double_value>,
"name":<String_value>,
"not_compliant_percentage":<Double_value>,
"si_device_ip_address":<String_value>,
"si_app_unit_name":<String_value>,
"__count":<Double_value>,
"not_compliant_count":<Double_value>,
"id":<String_value>,
"safety_index":<Double_value>,
"total_compliant_count":<Double_value>,
"total_attacks":<Double_value>}]}

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