Get alert profiles API
Last updated on:
The API returns the alert profile data that are available in EventLog Analyzer. The Alert Profile metadata can be used to filter alert search request.
Request URL
Request Header
| Header name | Value | Mandatory | Description |
|---|---|---|---|
| Authorization | Bearer {{AuthToken}} | Yes | Authtoken generated from API Settings page.
e.g: |
Request Parameters
The request needs to be sent in the body of the request using JSON format. And should contain following key/value parameters
| Parameter name | Default value | Mandatory | Type | Description |
|---|---|---|---|---|
| type | all | No | JSONArray | List of alert profile types |
| severity | all | No | JSONArray | List of severity |
| status | all | No | JSONArray | List of status |
Response
The response will be a JSON object which will contain the list of fields.
| Parameter name | Description |
|---|---|
| Number of Records | The count of records in the fetched response data |
| Profile Based Alerts | JSON Array of profile based alerts |
| Correlation Alert Profiles | JSON Array of correlation alert profiles |
Example usage using cURL
Sample request
curl --location --request POST 'http://localhost:8095/RestAPI/v1/meta/alert_profiles' \ -H "Accept: application/json" -H "Authorization: Bearer mdrkoda0odmtmznloc00ndziltg0mgutmwzkztljmjvmzwmx "
Sample response:
{ "Number of Records": 4, "Profile Based Alerts": [ { "Alert Id": 1001, "Alert profile name": "Alert Profile 1", "Type": "Predefined", "Status": "enabled", "Severity": "critical", "Notifications": ["SMS"] }, { "Alert Id": 1003, "Alert Profile Name": "Alert Profile 2", "Type": "Custom", "Status": "enabled", "Severity": "critical", "Notifications": ["Email"] }], "Correlation Alert Profiles": [ { "Alert profile name": "Rule 1", "Alert Id": 1234, "Type": "Correlation", "Status": "enabled", "Severity": "critical", "Notifications": [] }, { "Alert profile name": "Rule 2", "Alert Id": 1235, "Type": "Correlation Profile", "Status": "enabled", "Severity": "critical", "Notifications": [] } ... ] }
Example usage using Postman (Third party tool)
