Endpoint
/api/v2/tenants/{tenantId}/alert
Path Parameters
tenantIdstring
ackUrlstring
(Optional) Acknowledge URL.
alertTimestring
(Optional) Time when the alert was triggered.
alertTypestring
(Optional) Alert types. Use Get Alert Types API to fetch the list of alert types. Supported alert types are: monitoring, maintenance, appliance, agent, obsolete, scheduled maintenance.
appstring
Alert management applications. Use the Get Alert Technologies API to view supported alert management technologies.
availabilitystring
(Optional) Values: True/False. If set to true, creates availability alerts.
componentstring
(Optional) Device component.
currentStatestring
Current state of alert. For example: OK, warning, critical, or info.
descriptionstring
(Optional) Brief description of the entities that led to the alert generation. Note: You can find the origin of the alert and identify crossed types of threshold of the applied metrics. Primarily, details may include metric, monitor description, device type, template name, group, site, service level, and component.
deviceobject
Create alerts on a device. At least one field is required in order to identify the device:
Child Parameters
- device.hostName
- device.ipAddress
- device.macAddress
- device.providerUUID
- device.resourceUUID
- device.systemUUID
extAlertIdstring
(Optional) External alert ID.
monitorNamestring
(Optional) Monitor name.
resourceobject
Create alerts on a resource. At least one field is required in order to identify the device:
Child Parameters
- resource.aliasName
- resource.deviceGroups
- resource.extResourceId
- External ID of resource.
- resource.hostName
- The host name.
- resource.id
- The resource unique ID. Use the Search Resources API to get a list of resources.
- resource.ipAddress
- Resource IP address.
- resource.location
- resource.resourceName
- resource.resourceType
- resource.serviceGroups
- resource.tags
resourceNamestring
(Optional) Resource name.
rtypestring
(Optional) Resource type.
serviceNamestring
Service name.
subjectstring
Summary content of the generated alert. Content includes metrics that lead to the alert.
{
"alertTime": "2017-10-01T00:00:00+0000",
"alertType": "Maintenance",
"app": "OPSRAMP",
"component": "C",
"currentState": "CRITICAL",
"description": "api calls",
"device": {
"hostName": "Think-pad",
"ipAddress": "172.2.229.109",
"macAddress": "2E:8B:EB:32:7A:F9",
"providerUUID": "11767",
"resourceUUID": "DEV0000011767",
"systemUUID": "11767"
},
"monitorName": "test",
"serviceName": "CPU",
"subject": "Test API Alert for car"
}
{
"alertTime": "2018-11-02 10:52:55",
"alertType": "Monitoring",
"app": "OPSRAMP",
"component": "MEMORY",
"currentState": "CRITICAL",
"description": "Api calls ",
"resource": {
"id": "5b850347-8798-45aa-9332-c7ff3dd1c60e"
},
"serviceName": "MEMORY",
"subject": "The Physical Memory Usage on the device is 56%.The Virtual Memory Usage on the device is 43%."
}
{
"alertTime": "2018-11-02 10:52:55",
"alertType": "Monitoring",
"app": "OPSRAMP",
"component": "MEMORY",
"currentState": "CRITICAL",
"description": "Api calls ",
"masterAgentUUID": "5b850347-8798-45aa-9332-c7ff3dd1c60e",
"resource": {
"extResourceId": "646438712529389643",
"ipAddress": "172.24.132.47"
},
"serviceName": "MEMORY",
"subject": "The Physical Memory Usage on the device is 56%.The Virtual Memory Usage on the device is 43%."
}
{
"alertTime": "2019-07-12T00:00:00+0000",
"currentState": "CRITICAL",
"resource": {
"deviceGroups": [
{
"name": "dg1"
},
{
"name": "dg2"
}
],
"hostName": "Think-pad",
"location": {
"name": "San Jose"
},
"resourceType": "server",
"serviceGroups": [
{
"name": "sg1"
},
{
"name": "sg2",
"parent": {
"id": "SGP-a794d1de-e361-45ef-9d6e-4a450491bf35"
}
}
],
"tags": [
{
"environment": "QA"
},
{
"department": "R\u0026D"
}
]
},
"serviceName": "CPU",
"subject": "Performance Degradation on Windows Servers"
}
Responses
OK