Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

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

Sample Request
{
    "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 NameData TypeDescriptionMandatory
Status

STRING

NUMERIC

Indicates the status of the event/alert.

TRUE

AlertID

STRING

NUMERIC

Indicates the Event’s Alert ID.

TRUE

TriggeredDatetime

DATE AND TIME

Indicates the time when the event or alert was generated.
AlertMessage

STRING

Indicates the event or alert message or its description.

TRUE

EntityType

STRING

Entity, it is belonged it to either Infrastructure, Services or Applications.

TRUE

EntitySubType

STRING

Indicates Entities sub type. (Example: Router, Switch, etc...).

TRUE

ThresholdValue

NUMERIC

Indicates the threshold value of the parameter/metric for which the event/alert created.

FALSE

CurrentValue

NUMERIC

Current value of the parameter/metric for which the event/alert created.

FALSE

ParameterName

STRING

Name of the parameter/metric for which the event/alert created.

TRUE

AdditionalInfo

STRING

Additional information of the event/alert. (Example: Drive name of hard disk)

FALSE

HostName_or_ServiceName

STRING

Indicates the Host Name or Service name of the entity.

TRUE, if EntityType is Services or Applications. 

IPAddress

NUMERICwith dot .

Indicates the IP Address of the entity from where the event/alert is generated. 

TRUE, if EntityType is Infrastructure.

AlertSeverity

STRING

Event’s/Alert’s Severity (Example: Critical, Warning, Alert, Information etc.,)

TRUE

MonitoringToolName

STRING

Name of the source tool, where the event/alert is generated. (Example: Solarwinds, etc...)

TRUE

Sample Response
{
    "StatusResponseList": [
        {
            "AlertID": "90473",
            "message": "Event Sent Successfully",
            "status": "Success"
        }
    ],
    "Error": null,
    "isValid": true
}

Response Parameters

Parameter NameTypeDescription
AlertID

NUMERIC

STRING

AlertID, which is used to send the API request.

message

STRING

Indicates the message, if the PostEvent is sent successfully.

status

STRING

Indicates whether the PostEvents API is executed successfully or failed.

Error

STRING

Displays null, if there are no errors.

isValid

STRING

Indicates if the Response is valid or not.

Status and Error Codes

For more information, see Status and Error Messages


 

  • No labels