REST API - GET Events

This operation returns a list of CommCell events.

Request

Syntax

GET webservice/Events?clientId=clientId&fromTime=fromTime&toTime=toTime&showInfo=showInfo&showMinor=showMinor&showMajor=showMajor&showCritical=showCritical HTTP/1.1
 Host: host name
 Accept: application/xml
 Authtoken: authentication token

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name	Description	Required
clientId	The client ID for the client. If the client ID is not known, use the GET Client API to retrieve it.	No
fromTime	The option to return events based on the time they were created. This parameter can be used with the toTime parameter or by itself. Valid values are UNIX-style timestamps (seconds since January 1, 1970).	No
toTime	The option to return events based on time they were created. This parameter can be used with the fromTime parameter or by itself. Valid values are UNIX-style timestamps (seconds since January 1, 1970).	No
showInfo	The option to filter out informational events. Valid value is False.	No
showMinor	The option to filter out minor events. Valid value is False.	No
showMajor	The option to filter out major events. Valid value is False.	No
showCritical	The option to filter out critical events. Valid value is False.	No

Request Headers

Name	Description
Host	The host name of the Web Server or the Command Center used in the API request.
Accept	The format of the response. Valid values are: application/xml or application/json.
Authtoken	The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter	Description	Element
severity	The severity level of each event. Valid values are: 0, Information 3, Minor 6, Major 9, Critical	commservEvents
eventCode	The system-generated ID assigned to the event.	commservEvents
jobId	The system-generated ID assigned to the job.	commservEvents
acknowledge		commservEvents
subsystem	The subsystem that generated the event, for example, JobManager.	commservEvents
description	The description of the event. For example, Data Aging operation has completed.	commservEvents
id	The system-generated ID assigned to a particular instance of an event.	commservEvents
timeSource	The time the event happened. Valid values are UNIX-style timestamps (seconds since January 1, 1970).	commservEvents
type		commservEvents
clientId	The system-generated ID assigned to the client.	clientEntity
clientName	The name of the client.	clientEntity

Examples

Sample Request

This request returns all events that happened after Wed, 10 Feb 2016 19:37:15 GMT.

GET webservice/Events?fromTime=1455133035 HTTP/1.1
 Host: client.mydomain.com
 Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

This request returns all critical events by filtering out informational, minor, and major events.

GET webservice/Events?showInfo=false&showMinor=false&showMajor=false HTTP/1.1
 Host: client.mydomain.com
 Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

 
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
 <App_GetCommservEventsResp><commservEvents severity="9" eventCode="234881220" acknowledge="0" subsystem="CVD" description="Index cache [C:\Program Files\Commvault\ContentStore\IndexCache] free space on MediaAgent [MA2016] is [17017] MB. It is considered critically low. Backups will start failing if the cache runs out of space. Take one of the following actions: 1. Increase the index cache total disk space. 2. Reduce the retention setting on the index cache." id="1785" timeSource="1455133035" type="0"><clientEntity clientId="2" clientName="MA2016" /></commservEvents></App_GetCommservEventsResp>