---
updatedAt: 2026-05-12T10:00:34.000Z
---

# Check scan rule change

This operation allows you to check what vulnerabilities will be affected by a scan rule change. The response includes an object containing information about affected vulnerabilities.

# OpenAPI definition

```json
{
  "components": {
    "responses": {
      "BadRequestResponse": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorMessage"
            }
          }
        },
        "description": "BadRequestResponse indicates a request with invalid parameters"
      },
      "ForbiddenResponse": {
        "description": "ForbiddenResponse signals a request for a resource that does not exist or is not authorized"
      },
      "GenericError": {
        "description": "GenericError generic error"
      },
      "UnauthorizedResponse": {
        "description": "UnauthorizedResponse signals an unauthorized API access"
      },
      "runScanRulesResponse": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/runScanRulesResponseSwagger"
            }
          }
        },
        "description": "runScanRulesResponse provides an information regarding scan rules"
      }
    },
    "schemas": {
      "ErrorMessage": {
        "description": "ErrorMessage describes the error",
        "properties": {
          "code": {
            "format": "int64",
            "type": "integer"
          },
          "reason": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "ScanRule": {
        "description": "ScanRule holds the structure of a scan rule for a site",
        "properties": {
          "else": {
            "description": "else - branch conditional",
            "type": "string"
          },
          "id": {
            "description": "ID of scan rule",
            "type": "string"
          },
          "isRoot": {
            "description": "isRoot - indicates if this is a root scan rule (there should always be a root rule)",
            "type": "boolean"
          },
          "maxCount": {
            "description": "maxCount - the number of matching URLs that, when reached, will trigger the 'then' condition",
            "format": "int64",
            "type": "integer"
          },
          "regex": {
            "description": "regex - the regular expression used for this rule",
            "type": "string"
          },
          "regexR": {
            "description": "regexR - a condition that allows search and replace in a specific URL for parameter values",
            "type": "string"
          },
          "sift": {
            "description": "sift - a condition that randomizes what links get added to a scan. Values range from 0.1 - 1.0 (0.1 = 10%, 1.0 = 100%). Useful for templated content.",
            "format": "double",
            "type": "number"
          },
          "then": {
            "description": "then - branch conditional",
            "type": "string"
          }
        },
        "required": [
          "id"
        ],
        "type": "object"
      },
      "ScanRules": {
        "description": "ScanRules contains assetID, siteID, and the list of associated scan rules",
        "properties": {
          "assetID": {
            "description": "Asset ID",
            "format": "int64",
            "type": "integer"
          },
          "scanRules": {
            "items": {
              "$ref": "#/components/schemas/ScanRule"
            },
            "type": "array"
          },
          "siteID": {
            "description": "Site ID",
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "assetID"
        ],
        "type": "object"
      },
      "findingSwagger": {
        "description": "Finding is the data returned by the findings endpoint",
        "properties": {
          "asset": {
            "properties": {
              "clientID": {
                "format": "int64",
                "type": "integer"
              },
              "customPolicyID": {
                "format": "int64",
                "nullable": true,
                "type": "integer"
              },
              "id": {
                "format": "int64",
                "type": "integer"
              },
              "name": {
                "type": "string"
              },
              "rating": {
                "type": "string"
              },
              "serviceLevel": {
                "format": "int64",
                "type": "integer"
              },
              "status": {
                "type": "boolean"
              },
              "subID": {
                "format": "int64",
                "type": "integer"
              },
              "type": {
                "type": "string"
              },
              "location": {
                "type": "string",
                "enum": [
                  "Internal",
                  "External"
                ]
              },
              "phase": {
                "type": "string",
                "enum": [
                  "pre-production",
                  "production",
                  "discontinued",
                  ""
                ]
              }
            },
            "type": "object"
          },
          "attackVectors": {
            "items": {
              "format": "int64",
              "type": "integer"
            },
            "nullable": true,
            "type": "array"
          },
          "attackVectorsCount": {
            "format": "int64",
            "nullable": true,
            "type": "integer"
          },
          "class": {
            "properties": {
              "defaultRisk": {
                "format": "int64",
                "type": "integer"
              },
              "hasApplications": {
                "type": "boolean"
              },
              "hasSites": {
                "type": "boolean"
              },
              "id": {
                "format": "int64",
                "type": "integer"
              },
              "name": {
                "type": "string"
              },
              "retired": {
                "type": "boolean"
              },
              "shortName": {
                "type": "string"
              }
            },
            "type": "object"
          },
          "closed": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "customAccepted": {
            "type": "boolean"
          },
          "customRisk": {
            "format": "int64",
            "nullable": true,
            "type": "integer"
          },
          "cveTags": {
            "items": {
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "cweTags": {
            "items": {
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "cvssScore": {
            "format": "double",
            "type": "number"
          },
          "cvssV3": {
            "properties": {
              "environmentalScore": {
                "format": "double",
                "nullable": true,
                "type": "number"
              },
              "environmentalVector": {
                "properties": {
                  "a": {
                    "type": "string"
                  },
                  "ac": {
                    "type": "string"
                  },
                  "ar": {
                    "type": "string"
                  },
                  "av": {
                    "type": "string"
                  },
                  "c": {
                    "type": "string"
                  },
                  "cr": {
                    "type": "string"
                  },
                  "i": {
                    "type": "string"
                  },
                  "ir": {
                    "type": "string"
                  },
                  "ma": {
                    "type": "string"
                  },
                  "mac": {
                    "type": "string"
                  },
                  "mav": {
                    "type": "string"
                  },
                  "mc": {
                    "type": "string"
                  },
                  "mi": {
                    "type": "string"
                  },
                  "mpr": {
                    "type": "string"
                  },
                  "ms": {
                    "type": "string"
                  },
                  "mui": {
                    "type": "string"
                  },
                  "pr": {
                    "type": "string"
                  },
                  "s": {
                    "type": "string"
                  },
                  "ui": {
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "score": {
                "format": "double",
                "type": "number"
              },
              "vector": {
                "properties": {
                  "a": {
                    "type": "string"
                  },
                  "ac": {
                    "type": "string"
                  },
                  "ar": {
                    "type": "string"
                  },
                  "av": {
                    "type": "string"
                  },
                  "c": {
                    "type": "string"
                  },
                  "cr": {
                    "type": "string"
                  },
                  "i": {
                    "type": "string"
                  },
                  "ir": {
                    "type": "string"
                  },
                  "ma": {
                    "type": "string"
                  },
                  "mac": {
                    "type": "string"
                  },
                  "mav": {
                    "type": "string"
                  },
                  "mc": {
                    "type": "string"
                  },
                  "mi": {
                    "type": "string"
                  },
                  "mpr": {
                    "type": "string"
                  },
                  "ms": {
                    "type": "string"
                  },
                  "mui": {
                    "type": "string"
                  },
                  "pr": {
                    "type": "string"
                  },
                  "s": {
                    "type": "string"
                  },
                  "ui": {
                    "type": "string"
                  }
                },
                "type": "object"
              }
            },
            "type": "object"
          },
          "directRemediationAvailable": {
            "type": "boolean"
          },
          "firstOpened": {
            "format": "date-time",
            "type": "string"
          },
          "foundRevision": {
            "nullable": true,
            "type": "string"
          },
          "hasInstanceLevelCVSSCustomization": {
            "type": "boolean"
          },
          "hasInstanceLevelCustomization": {
            "type": "boolean"
          },
          "id": {
            "description": "This is a copy because go-swagger does not support overriding type information\nso all SQL null handling shows as objects instead of primitive type",
            "format": "int64",
            "type": "integer"
          },
          "impact": {
            "format": "int64",
            "type": "integer"
          },
          "impactRating": {
            "type": "string"
          },
          "isAccessible": {
            "type": "boolean"
          },
          "lastModified": {
            "format": "date-time",
            "type": "string"
          },
          "lastRetested": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "likelihood": {
            "format": "int64",
            "type": "integer"
          },
          "likelihoodRating": {
            "type": "string"
          },
          "location": {
            "type": "string"
          },
          "manual": {
            "type": "boolean"
          },
          "nonAcceptedStatus": {
            "nullable": true,
            "type": "string"
          },
          "notesCount": {
            "format": "int64",
            "nullable": true,
            "type": "integer"
          },
          "opened": {
            "format": "date-time",
            "type": "string"
          },
          "outOfScopeReasons": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "reason": {
            "nullable": true,
            "type": "string"
          },
          "retestStatus": {
            "type": "string"
          },
          "risk": {
            "format": "int64",
            "type": "integer"
          },
          "severity": {
            "format": "int64",
            "nullable": true,
            "type": "integer"
          },
          "status": {
            "type": "string"
          },
          "subTypeTags": {
            "items": {
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "tags": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "threat": {
            "format": "int64",
            "nullable": true,
            "type": "integer"
          },
          "unreachable": {
            "nullable": true,
            "type": "boolean"
          },
          "verificationStatus": {
            "type": "string"
          },
          "zeroDayTags": {
            "items": {
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          }
        },
        "type": "object"
      },
      "runScanRulesResponseSwagger": {
        "properties": {
          "inScope": {
            "items": {
              "$ref": "#/components/schemas/findingSwagger"
            },
            "nullable": true,
            "type": "array"
          },
          "outOfScope": {
            "items": {
              "$ref": "#/components/schemas/findingSwagger"
            },
            "nullable": true,
            "type": "array"
          },
          "unaffected": {
            "items": {
              "$ref": "#/components/schemas/findingSwagger"
            },
            "nullable": true,
            "type": "array"
          }
        },
        "type": "object"
      }
    }
  },
  "info": {
    "license": {
      "name": "(c) Copyright 2022 WhiteHat Security"
    },
    "title": "Findings API",
    "version": "2.0.0"
  },
  "openapi": "3.0.1",
  "paths": {
    "/api/runScanRules": {
      "post": {
        "description": "This operation allows you to check what vulnerabilities will be affected by a scan rule change. The response includes an object containing information about affected vulnerabilities.",
        "operationId": "runScanRulesSwagger",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ScanRules"
              }
            }
          },
          "description": "Body of the request holds the array of ScanRule and also holds SiteID and AssetID",
          "required": true,
          "x-go-name": "Body"
        },
        "responses": {
          "200": {
            "$ref": "#/components/responses/runScanRulesResponse"
          },
          "400": {
            "$ref": "#/components/responses/BadRequestResponse"
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedResponse"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenResponse"
          },
          "500": {
            "$ref": "#/components/responses/GenericError"
          }
        },
        "summary": "Check scan rule change",
        "tags": [
          "Findings API v2.0"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://sentinel.whitehatsec.com/"
    }
  ],
  "tags": [
    {
      "name": "Findings API v2.0"
    }
  ],
  "x-explorer-enabled": false,
  "x-readme": {
    "proxy-enabled": true
  }
}
```