Release 4.3 API
October 29, 2024
Before understanding the API release highlights, learn more about the API server URL to be used in your API requests by referring to the Know Your Qualys API Server URL section. For this API Release Notes, <qualys_base_url> is mentioned in the sample API requests.
What's New?
Additional Fields in Output Response
With this release, we have added the following fields in response to the two Incident APIs: the Approve Incident API and the Fetch Incidents API. The parameters include the reviewer's name, ID, and the date of the review. This helps in better tracking incident approvals and reviews, enabling detailed audit trails for compliance. Organizations can leverage this information to generate customized reports for deeper analysis and targeted improvements.
| Field | Description |
| reviewedById | Displays ID of reviewer. |
| reviewedByName | Displays name of reviewer. |
| reviewedDate | Displays when the review was performed. |
Approve Incidents API
| New or Updated API | Updated |
| API Endpoint | /fim/v3/incidents/{incidentId}/approve |
| Method | POST |
| DTD or XSD changes | Not Applicable |
SampleSample
API Request
curl -X POST '<qualys_base_url>/fim/v3/incidents/{incidentId}/approve--header 'Authorization: Bearer <authToken>' --header 'content-type: application/json' --data-raw '{ "approvalStatus":"APPROVED", "changeType":"MANUAL", "comment":"Events under this incident have been reviewed ", "dispositionCategory":"PATCHING" }'
Response
{
"customerId":"25a14e60-80c1-4c25-8166-6653a4e2b094",
"type":"AUTOMATED",
"id":"486c1675-c752-4f5e-b34d-4b63774d252d",
"filterFromDate":"2024-10-14T05:00:00.000+0000",
"filterToDate":"2024-10-14T21:29:00.000+0000",
"name":"test_4April-20241014-060712",
"filters":[
"dateTime: ['2024-10-14T05:00:00.000Z'..'2024-10-14T21:29:00.000Z'] and (action:Create )"
],
"status":"CLOSED",
"reviewers":[
"john_doe",
"Johndoe",
"johnsmith@qualys.com"
],
"comment":"Events under this incident have been reviewed ",
"assignDate":"2024-10-14T06:07:12.894+0000",
"approvalDate":"2024-10-15T05:14:14.888+0000",
"approvalStatus":"APPROVED",
"dispositionCategory":"PATCHING",
"changeType":"MANUAL",
"approvalType":"MANUAL",
"createdById":"51fbdb4b-5fb5-fdf6-8141-5a7887ec557b",
"createdByName":"FIM Automation",
"createdDate":"2024-10-14T06:07:12.875+0000",
"lastUpdatedById":"51fbdb4b-5fb5-fdf6-8141-5a7887ec557b",
"lastUpdatedByName":"FIM Automation",
"lastUpdatedDate":"2024-10-14T07:21:45.670+0000",
"filterUpdatedDate":"2024-10-14T06:07:12.875+0000",
"deleted":false,
"marked":true,
"moved":null,
"markupStatus":"COMPLETED",
"ruleId":"23db69b0-0876-48a2-bdf5-058913585bbb",
"ruleName":"test_4April",
"slaRequired":false,
"slaDurationValue":0,
"slaDurationKey":null,
"slaViolationDate":null,
"reviewedById":"51fbdb4b-5fb5-fdf6-8141-5a7887ec557b",
"reviewedByName":"FIM Automation",
"reviewedDate":"2024-10-15T05:14:14.876+0000"
}
Fetch Incidents API
| New or Updated API | Updated |
| API Endpoint | /fim/v3/incidents/search |
| Method | POST |
| DTD or XSD changes | Not Applicable |
SampleSample
API Request
curl -X POST '<qualys_base_url>/fim/v3/incidents/search
--header 'Authorization: Bearer <authToken>'
--header 'content-type: application/json'
--data-raw
'{
"filter":"status:CLOSED",
"sort":"[\{\"dateTime\":\"desc\"}
]'
Response
[
{
"sortValues": [
1728882000000
],
"data": {
"slaDurationKey": null,
"approvalDate": "2024-10-15T05:14:14.888+0000",
"approvalType": "MANUAL",
"markupStatus": "COMPLETED",
"type": "AUTOMATED",
"slaViolationDate": null,
"filterFromDate": "2024-10-14T05:00:00.000+0000",
"customerId": "25a14e60-80c1-4c25-8166-6653a4e2b094",
"ruleName": "test_4April",
"id": "486c1675-c752-4f5e-b34d-4b63774d252d",
"ruleId": "23db69b0-0876-48a2-bdf5-058913585bbb",
"approvalStatus": "APPROVED",
"marked": true,
"lastUpdatedBy": {
"date": 1728890505670,
"user": {
"name": "FIM Automation",
"id": "51fbdb4b-5fb5-fdf6-8141-5a7887ec557b"
}
},
"filterToDate": "2024-10-14T21:29:00.000+0000",
"assignDate": "2024-10-14T06:07:12.894+0000",
"changeType": "MANUAL",
"filters":
[
"dateTime: ['2024-10-14T05:00:00.000Z'..'
2024-10-14T21:29:00.000Z'] and (action:Create )"
],
"reviewedBy": {
"date": 1728969254876,
"user": {
"name": "FIM Automation",
"id": "51fbdb4b-5fb5-fdf6-8141-5a7887ec557b"
}
},
"reviewers": [
"john_doe",
"johndoe",
"johnsmith@qualys.com"
],
"slaDurationValue": 0,
"deleted": false,
"createdBy": {
"date": 1728886032875,
"user": {
"name": "FIM Automation",
"id": "51fbdb4b-5fb5-fdf6-8141-5a7887ec557b"
}
},
"slaRequired": false,
"name": "test_4April-20241014-060712",
"comment": "Events under this incident have been reviewed ",
"dispositionCategory": "PATCHING",
"status": "CLOSED"
}
}
]