URL
GET https://{api-url}/api/v2/tenants/{tenantId}/alerts/{alertId}Sample URLs
https://{api-url}/api/v2/tenants/client_8/alerts/93Parameters
| Field | Description |
|---|---|
| eventType | The event type is defined as one of the following:
|
| inferenceId | Indicates an inference that is correlated to an event. |
| status | Indicates an action performed on an alert:
|
Note
For an inference alert, resource name and client ID are provided in the response. For an RCA alert, device ID, Name, and IP address are provided in the response.Sample responses
This is a sample response of a raw alert:
{
"uniqueId" : "93",
"subject" : "Disk c:\\ Critical.
Used 90.31%;
Free 9.69%;
Disk Capacity 102642 MB. Threshold is 90%.",
"description" : "Disk c:\\ is critical.(Crossed 90% usage).
Total-102642 MB;
Used-92700 MB (90.31%);
Free-9942 MB (9.69%);",
"currentState" : "Critical",
"oldState" : "Critical",
"serviceName" : "Disk",
"acknowledged" : false,
"suppressed" : false,
"permanentlySuppressed" : false,
"closed" : false,
"ticketed" : true,
"clientUniqueId" : "client_8",
"alertType" : "Obsolete",
"app" : "OPSRAMP",
"alertTime" : "2016-07-24T10:40:47+0000",
"device":
{
"id": "253151d1-6b19-4158-9d91-050e7fb4dd8d",
"name": "res1",
"hostName": "res1",
"ipAddress": "1.23.4.5",
"type": "DEVICE",
"aliasName": "alias name",
"resourceName": "res name",
"resourceType": "Desktop"
},
"resource":
{
"id": "253151d1-6b19-4158-9d91-050e7fb4dd8d",
"hostName": "res1",
"ipAddress": "1.23.4.5",
"type": "Desktop",
"aliasName": "alias name",
"name": "check code",
"resourceName": "res name",
"consoles": [],
"resourceType": "Desktop",
"frequency": 0,
"paused": false,
"deleted": false,
"validateSSL": false,
"port": 0,
"encrypted": false,
"timeout": 0,
"days": 0,
"ts": 0,
"clientId": 0,
"locationOffset": 0,
"totalLocations": 0,
"receiverHostPort": 0
},
"repeatCount" : "2",
"tenantId" : 8,
"status" : "Ticketed",
"priority" : "N/A",
"elapsedTimeString" : "64d 59m ",
"createdDate" : "2016-07-24T10:40:47+0000",
"updatedTime" : "2016-07-24T10:40:50+0000",
"rba" : false,
"tenantName" : "Brocade Lab",
"managedByOpsRamp" : false,
"incidentId" : "INC0000000093",
"actedTs" : 0,
"eventType": "ALERT",
"metric" : "Disk",
"inferenceId": 0,
"statusHistory":
{
"createdBy": "system",
"createdTime": "2016-07-24T10:40:47+0000"
"ticketedBy": "opsramp_system_user ",
"ticketedTime": "2016-07-24T10:41:47+0000"
}
}This is a sample Response of an inference Alert:
{
"uniqueId": "3511",
"subject": "Inference test",
"description": "Inference test",
"currentState": "Ok",
"oldState": "Critical",
"acknowledged": false,
"suppressed": false,
"permanentlySuppressed": false,
"closed": false,
"ticketed": false,
"clientUniqueId": "client_12",
"alertType": "MONITORING",
"app": "OPSRAMP",
"component": "b717911b-04ce-37ce-9af8-e2242813eaa3",
"alertTime": "2018-05-07T11:00:28+0000",
"resource":
{
"name": "2adc3-aiops",
"type": "CLIENT",
"metaData": {}
},
"repeatCount": "2",
"tenantId": 12,
"status": "New",
"priority": "N/A",
"elapsedTimeString": "3d 20h 45m ",
"healedTimeString": "1h 54m ",
"createdDate" : "2018-05-07T12:55:19+0000",
"updatedTime": "2018-05-07T12:55:19+0000",
"rba": false,
"tenantName": "2adc3-aiops",
"managedByOpsRamp": false,
"actedTs": 0,
"eventType": "INFERENCE",
"inferenceId": 0,
"statusHistory":
{
"createdBy": "system",
"createdTime": "2018-05-07T12:55:19+0000"
}
}