Fetch all Correlation Rules API

Use this API to fetch all Correlation Rules.

POST/fim/v3/autocorrelation/rules/search

Input ParametersInput Parameters

Parameter

Mandatory/Optional

Data Type

Description

attributes Optional

String

(Optional) The list of comma-separated attributes that you want to include in the response.

filter Optional

String

(Optional) Filter the correlation rules by providing a query using Qualys syntax. Refer to the “How to Search” topic in the Online Help for assistance with creating your query.

For example - scheduleType: DAILY

pageNumber

Optional

String

(Optional) The page number to be returned. The number

starts from zero.

pageSize

Optional

String

(Optional) The number of records per page to be included in

the response. Default is 10.

sort

Optional

String

(Optional) Sort the results using correlation rule attributes.

Example: "sort":"[{\"ruleName\":\"asc\"}]"

SampleSample

API Request

curl -X POST
<qualys_base_url>/fim/v3/autocorrelation/rules/search 
-H 'authorization: Bearer <token>' 
-H 'content-type: application/json' 
-d @request.json

Contents of request.json

{
  "pageSize": 1,
  "pageNumber": 1,
  "filter": "approvalType:`MANUAL` ",
  "sort": "[{\"ruleName\":\"asc\"}]"
}

Response

[
  {
    "fixDate": "2020-03-27",
    "approvalStatus": null,
    "updatedBy": {
      "date": 1585289546339
    },
    "changeType": null,
    "approvalType": "MANUAL",
    "description": "",
    "reviewers": [
      "quays_fa"
    ],
    "deletedBy": null,
    "deleted": false,
    "scheduleType": "ONETIME",
    "dayOfMonth": null,
    "createdBy": {
      "date": 1585289546339
    },
    "customerId": "25x14x60-80x1-4x25-8166-6653x4x2x094",
    "ruleName": "*",
    "days": [],
    "startTime": "06:30:00",
    "dispositionCategory": null,
    "comment": "",
    "id": "1xxx7x30-x730-4x94-xx03-xx98x4xx28x1",
    "endTime": "08:00:00",
    "filterQuery": "action:Create",
    "status": "ACTIVATED"
  }
]