device_event_summary

Last published : Aug 10, 2026
Configuration for devices events summary resource.
Related information

Properties

(click to see Operations )
Name Data Type Permissions Description
id <String> Read-write Id is system generated key.
device_ip_address <String> Read-write ip_address of the device..
instance_id <String> Read-write Instance ID of the managed device.. Minimum length = 1 Maximum length = 256
type <String> Read-write Device Family. Minimum length = 1 Maximum length = 64
hostname <String> Read-write Assign hostname to managed device, if this is not provided, name will be set as host name . Minimum length = 1 Maximum length = 256
total_critical_events <Integer> Read-only Total number of Critical events city wise..
total_major_events <Integer> Read-only Total number of major events city wise..
total_events <Integer> Read-only Total number of events.
instance_state <String> Read-only State of device, UP only if device accessible.

Operations

(click to see Properties )
  • GET (ALL)
  • GET
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/device_event_summary Query-parameters:
filter https://<MGMT-IP>/nitro/v2/config/device_event_summary ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of device_event_summary 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/device_event_summary ?pagesize=#no;pageno=#no Use this query-parameter to get the device_event_summary resources in chunks.
count https://<MGMT-IP>/nitro/v2/config/device_event_summary ?count=yes Use this query-parameter to get the count of device_event_summary resources.
HTTPS Method: GET
Request Headers: Accept: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
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, "device_event_summary":[{
"total_critical_events":<Integer_value>,
"total_major_events":<Integer_value>,
"id":<String_value>,
"device_ip_address":<String_value>,
"instance_id":<String_value>,
"total_events":<Integer_value>,
"type":<String_value>,
"hostname":<String_value>,
"instance_state":<String_value>}]}

get

URL: https://<MGMT-IP>/nitro/v2/config/device_event_summary/id_value<String> HTTPS Method: GET
Request Headers: Accept: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
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, "device_event_summary":[{
"total_critical_events":<Integer_value>,
"total_major_events":<Integer_value>,
"id":<String_value>,
"device_ip_address":<String_value>,
"instance_id":<String_value>,
"total_events":<Integer_value>,
"type":<String_value>,
"hostname":<String_value>,
"instance_state":<String_value>}]}