Use this API to search the details for the given rule id.
The API returns the default value for the following fields:
For Single Match: slideTime, matchCount, aggregate, aggregationKeys.
For Time-Window Scheduled Match: slideTime, matchCount.
|
Parameter |
Mandatory/Optional |
Data Type |
Description |
|---|---|---|---|
| ruleId | Mandatory | String | Provide the ID of the alert rule for which you require details. |
API Request
curl -X GET
<qualys_base_url>/fim/v3/alert/rules/{ruleId}
-H 'authorization: Bearer <token>'
-H 'content-type: application/json'Response
{
"customerId": "x5x0514x-x211-x1x4-809x-x3x2xx667xxx",
"applicationName": "FIM",
"id": "8xx98x30-xx5x-11x9-9036-339x439x1x4x",
"datasource": "EVENTS",
"ruleType": "simple_alert",
"name": "",
"description": "",
"qql": "(file.fullPath:'*\\System32\\*' and action:Attributes )",
"windowTime": 0,
"slideTime": 900000,
"matchCount": 3,
"fromHour": 0,
"fromMinute": 0,
"duration": 0,
"aggregate": true,
"aggregationKeys": [
"tokens"
],
"actions": [
{
"id": "54x62750-xx5x-11x9-9525-51x120x87xx9",
"actionType": "qemail",
"name": "Alerting 2.1.2 Testing",
"subject": "Alerting 2.1.2 Testing",
"alert": "Alerting 2.1.2 Testing",
"emailRecipients": [
"jd1@qualys.com",
"jd2@qualys.com",
"jd@qualys.com"
],
"slackChannel": null,
"subjectParameters": [],
"bodyParameters": []
}
],
"created": 1569172952451,
"createdBy": "John Doe",
"createdById": "doe_john",
"updated": 1569332877053,
"updatedBy": "John Doe",
"updatedById": "doe_john",
"lastRun": 1569312595868,
"active": false,
"ruleState": "DISABLED",
"actionNames": [
"Alerting 2.1.2 Testing"
],
"trigger": "Single Match"
}