Endpoint
/api/v2/tenants/{tenantId}/alerts/{alertId}
Path Parameters
tenantIdstring
Describes the client ID or msp ID of the tenant
alertIdstring
Alert unique Identifier
Responses
OK
acknowledgedboolean
actedTsinteger
alertTimestring
alertTypestring
appstring
clientUniqueIdstring
closedboolean
createdDatestring
currentStatestring
descriptionstring
deviceobject
Child Parameters
- device.aliasName
- device.hostName
- device.id
- device.ipAddress
- device.name
- device.resourceName
- device.resourceType
- device.type
elapsedTimeStringstring
eventTypestring
The event type is defined as one of the following: - `eventType: ALERT` represents a raw alert. - `eventType: RCA` represents an RCA alert. - `eventType: Inference` represents an inference alert.
incidentIdstring
inferenceIdinteger
Indicates an inference that is correlated to an event.
managedByOpsRampboolean
metricstring
oldStatestring
permanentlySuppressedboolean
prioritystring
rbaboolean
repeatCountstring
resourceobject
Child Parameters
- resource.aliasName
- resource.clientId
- resource.consoles
- resource.days
- resource.deleted
- resource.encrypted
- resource.frequency
- resource.hostName
- resource.id
- resource.ipAddress
- resource.locationOffset
- resource.name
- resource.paused
- resource.port
- resource.receiverHostPort
- resource.resourceName
- resource.resourceType
- resource.timeout
- resource.totalLocations
- resource.ts
- resource.type
- resource.validateSSL
serviceNamestring
statusstring
Indicates an action performed on an alert: If an alert is acknowledged, then the result is `status: Acknowledged`. If no action is performed on an alert, then the result is `status: New`.
statusHistoryobject
Child Parameters
- statusHistory.createdBy
- statusHistory.createdTime
- statusHistory.ticketedBy
- statusHistory.ticketedTime
subjectstring
suppressedboolean
tenantIdinteger
tenantNamestring
ticketedboolean
uniqueIdstring
updatedTimestring
{
"acknowledged": false,
"actedTs": 0,
"alertTime": "2018-05-07T11:00:28+0000",
"alertType": "MONITORING",
"app": "OPSRAMP",
"clientUniqueId": "client_12",
"closed": false,
"component": "b717911b-04ce-37ce-9af8-e2242813eaa3",
"createdDate": "2018-05-07T12:55:19+0000",
"currentState": "Ok",
"description": "Inference test",
"elapsedTimeString": "3d 20h 45m ",
"eventType": "INFERENCE",
"healedTimeString": "1h 54m ",
"inferenceId": 0,
"managedByOpsRamp": false,
"oldState": "Critical",
"permanentlySuppressed": false,
"priority": "N/A",
"rba": false,
"repeatCount": "2",
"resource": {
"metaData": {},
"name": "2adc3-aiops",
"type": "CLIENT"
},
"status": "New",
"statusHistory": {
"createdBy": "system",
"createdTime": "2018-05-07T12:55:19+0000"
},
"subject": "Inference test",
"suppressed": false,
"tenantId": 12,
"tenantName": "2adc3-aiops",
"ticketed": false,
"uniqueId": "3511",
"updatedTime": "2018-05-07T12:55:19+0000"
}
{
"acknowledged": false,
"actedTs": 0,
"alertTime": "2016-07-24T10:40:47+0000",
"alertType": "Obsolete",
"app": "OPSRAMP",
"clientUniqueId": "client_8",
"closed": false,
"createdDate": "2016-07-24T10:40:47+0000",
"currentState": "Critical",
"description": "Disk c:\\ is critical.(Crossed 90% usage). Total-102642 MB; Used-92700 MB (90.31%); Free-9942 MB (9.69%);",
"device": {
"aliasName": "alias name",
"hostName": "res1",
"id": "253151d1-6b19-4158-9d91-050e7fb4dd8d",
"ipAddress": "1.23.4.5",
"name": "res1",
"resourceName": "res name",
"resourceType": "Desktop",
"type": "DEVICE"
},
"elapsedTimeString": "64d 59m ",
"eventType": "ALERT",
"incidentId": "INC0000000093",
"inferenceId": 0,
"managedByOpsRamp": false,
"metric": "Disk",
"oldState": "Critical",
"permanentlySuppressed": false,
"priority": "N/A",
"rba": false,
"repeatCount": "2",
"resource": {
"aliasName": "alias name",
"clientId": 0,
"consoles": [],
"days": 0,
"deleted": false,
"encrypted": false,
"frequency": 0,
"hostName": "res1",
"id": "253151d1-6b19-4158-9d91-050e7fb4dd8d",
"ipAddress": "1.23.4.5",
"locationOffset": 0,
"name": "check code",
"paused": false,
"port": 0,
"receiverHostPort": 0,
"resourceName": "res name",
"resourceType": "Desktop",
"timeout": 0,
"totalLocations": 0,
"ts": 0,
"type": "Desktop",
"validateSSL": false
},
"serviceName": "Disk",
"status": "Ticketed",
"statusHistory": {
"createdBy": "system",
"createdTime": "2016-07-24T10:40:47+0000",
"ticketedBy": "opsramp_system_user ",
"ticketedTime": "2016-07-24T10:41:47+0000"
},
"subject": "Disk c:\\ Critical Used 90.31%; Free 9.69%; Disk Capacity 102642 MB. Threshold is 90%.",
"suppressed": false,
"tenantId": 8,
"tenantName": "Brocade Lab",
"ticketed": true,
"uniqueId": "93",
"updatedTime": "2016-07-24T10:40:50+0000"
}