Fetch a List of Secret Detection Rules

Fetches the list of secret detection rules available in your account.

GET/csapi/v1.3/secretrule

Input ParametersInput Parameters

Parameter	Mandatory/Optional	Data Type	Description
filter	Optional	string	Filter the reports list by providing a query using Qualys syntax.
pageNumber	Optional	integer	Specify the page to be returned. Page numbers start with 1. The default value is 1.
pageSize	Optional	integer	Specify the number of records per page to be included in the response. The default value is 50.
sort	Optional	string	Sort the results using a Qualys token. Refer to the “Sortable tokens” topic in the online help for more information.

Sample: Fetch a List of Secret Detection RulesSample: Fetch a List of Secret Detection Rules

API Request

curl -X GET "<qualys_base_url>/csapi/v1.3/secretrule?pageNumber=1&pageSize=50"
-H "accept: */*"

Response

{
   "data": [
        {
          "ruleUuid": "0da96274-c969-11ed-afa1-0242ac120002", "type": "system",
          "category": "Linear", "severity": "MEDIUM",
          "secretDetector": "Linear API Token", "status": "Active",
          "regex": "lin_api_(?i)[a-z0-9]{40}", "created": 1687283765159,
          "updated": 1687283765159,
          "createdBy": "System", "updatedBy": "System", "keywords":    
             [
              "lin_api_"
             ],
          "groupName": null
        },
        {
         "ruleUuid": "c6c4165e-c960-11ed-afa1-0242ac120002", "type":  "system",
         "category": "Shopify", "severity": "HIGH",
         "secretDetector": "Shopify Token", "status": "Active",
         "regex": "shp(ss|at|ca|pa)_[a-fA-F0-9]{32}", "created": 1687283762140,
         "updated": 1687283762140,
         "createdBy": "System", "updatedBy": "System", "keywords": [
         "shppa_",
         "shpat_",
         "shpca_", "shpss_"
            ],
"groupName": ""
},
...
],
"count": "85",
"groups": {}
}