Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
| Scroll ignore | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
Scroll export button scope current template-id 4fda9400-a7df-4ede-a95f-e4ae5fcf4796 caption Download this Page add-on Scroll PDF Exporter
Using this API you can use post events from 3rd party monitoring systems to SummitAI Event Correlation Engine (ECE).
To authenticate the below API, see API Authentication and Authorization.
Service Name | HTTP Method |
|---|---|
| PostEvents | POST |
Sample Request
| Code Block | |||||
|---|---|---|---|---|---|
| |||||
{
"MoMAlertDataList": [
{
"Status": "OPEN",
"AlertID": "1000",
"TriggeredDatetime":"",
"AlertMessage": "CPU Utilization is high",
"EntityType":"INFRASTRUCTURE",
"EntitySubType":"",
"ThresholdValue":"",
"CurrentValue":"",
"ParameterName":"CPU Utilization",
"AdditionalInfo":"",
"HostName_or_ServiceName": "XXXX",
"IPAddress":"1.1.1.1",
"AlertSeverity":"Critical"
}
],
"MonitoringToolName": "Solarwinds"
}
|
Request Parameters
| Parameter Name | Data Type | Description | Mandatory | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Status |
| Indicates the status of the event/alert. |
| ||||||||||||||||||||
| AlertID |
| Indicates the Event’s Alert ID. |
| ||||||||||||||||||||
| TriggeredDatetime |
| Indicates the time when the event or alert was generated. | |||||||||||||||||||||
| AlertMessage |
| Indicates the event or alert message or its description. |
| ||||||||||||||||||||
| EntityType |
| Entity, it is belonged it to either Infrastructure, Services or Applications. |
| ||||||||||||||||||||
| EntitySubType |
| Indicates Entities sub type. (Example: Router, Switch, etc...). |
| ||||||||||||||||||||
| ThresholdValue |
| Indicates the threshold value of the parameter/metric for which the event/alert created. |
| ||||||||||||||||||||
| CurrentValue |
| Current value of the parameter/metric for which the event/alert created. |
| ||||||||||||||||||||
| ParameterName |
| Name of the parameter/metric for which the event/alert created. |
| ||||||||||||||||||||
| AdditionalInfo |
| Additional information of the event/alert. (Example: Drive name of hard disk) |
| ||||||||||||||||||||
| HostName_or_ServiceName |
| Indicates the Host Name or Service name of the entity. |
| ||||||||||||||||||||
| IPAddress |
| Indicates the IP Address of the entity from where the event/alert is generated. |
| ||||||||||||||||||||
| AlertSeverity |
| Event’s/Alert’s Severity (Example: Critical, Warning, Alert, Information etc.,) |
| ||||||||||||||||||||
| MonitoringToolName |
| Name of the source tool, where the event/alert is generated. (Example: Solarwinds, etc...) |
|
| Code Block | theme | DJango|||
|---|---|---|---|---|
| ||||
{
"StatusResponseList": [
{
"AlertID": "90473",
"message": "Event Sent Successfully",
"status": "Success"
}
],
"Error": null,
"isValid": true
} |
Response Parameters
| Parameter Name | Type | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AlertID |
| AlertID, which is used to send the API request. | ||||||||||||||
message |
| Indicates the message, if the PostEvent is sent successfully. | ||||||||||||||
status |
| Indicates whether the PostEvents API is executed successfully or failed. | ||||||||||||||
Error |
| Displays null, if there are no errors. | ||||||||||||||
isValid |
| Indicates if the Response is valid or not. |
Status and Error Codes
For more information, see Status and Error Messages
| Scroll ignore | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|