Not the same as other exclusions
Three features leave things out, and each works differently:
A rule on this page never changes monitor matches or Domain monitoring results, and the other two never change an assessment report.
Availability and cost
Availability: Attack Surface Reports or Targeted Attack Surface Reports, included in every edition. Either feature opens every endpoint on this page. Cost: no metered allowance. Rules use none of your Attack Surface allowances and have no limit on how many you keep. With an API key, each call that returns2xx counts once toward your monthly API Calls allowance. Any other status is refunded. See Rate limits.
Without either feature, every call on this page returns 403 with {"detail": "This feature is not included in your plan."}. A lapsed license returns the same message here. These endpoints never return the allowance 429 or a capacity 409. See Plans and quotas.
Create a rule
POST /api/hackerview/exclusions/ creates one rule.
The call returns
201 with the rule:
id to delete the rule later. ext_org_id is your organization’s ID.
Value types
value_type decides how value is read and matched, and which reports the rule changes. The value comes back in its stored form.
- A
domainrule marks a domain as legitimate. It drops breach results for that domain, and the Domain Spoofing Risk Report stops flagging it as a look-alike. Use it for a domain that resembles yours but is yours or a partner’s, such asacme-login.comfor your own sign-in pages. - A
cverule removes the CVE from the vulnerability findings. A finding from another module that mentions the same CVE can remain. To remove that finding too, add afindingrule. - Activity and Change Comparison reports apply the rules that match their own data, and count what they removed in
exclusions_applied. See Read assessment report data.
Exclude one finding
Afinding rule removes a single web application, TLS or admin panel finding. Send its three parts in extra. value is required but replaced by the stored form, so send the stored form itself:
moduleisweb_app_security,tls_postureoradmin_panels. Other values are accepted but match nothing.hostandcheck_idcome from the finding in a report. Read them frommodules.web_app_security,modules.tls_postureormodules.admin_panelswith the report data endpoints. An admin panel finding without acheck_iduses itspanel_type.
Scope a rule to a domain
target_domain decides which assessments a rule applies to:
- Empty or omitted: every assessment your organization runs.
- A domain: the assessments that cover it. A rule applies when its
target_domainis one of the assessment’s domains or a subdomain of one. An assessment’s domains are the assessed domain, the domain you submitted, the other domains it covered (for example withdomain_modeall, see Domain handling), and the domains you approved inactive_scope_domains.
www.acme.com therefore applies to an assessment of acme.com, and then matches its value across that whole assessment, not only under www. With domain_mode all, a rule scoped to another of your domains also applies to an assessment of acme.com that covered that domain.
target_domain is lowercased. It must be a domain such as acme.com: letters, digits, dots and hyphens, with at least one dot, up to 253 characters.
Keep a host visible but excluded
suppress_findings applies to hostname, ip and cidr rules:
Rules of every other type always remove what they match.
suppress_findings has no effect on them.
Add a host the assessment missed
An include rule adds a host or IP address to the assessment when discovery does not find it. The assessment then checks it like any other host.- Only
hostnameandipwork as include rules. The API accepts other value types with"list_type": "include", but they have no effect. To assess several domains, usedomain_modewhen you start an assessment. See Domain handling. - Include rules apply while an assessment runs. Generating a report again does not add the host. Start a new assessment.
- Scope works the same way as for exclusion rules.
Update a rule
There is no update endpoint. Send the same rule again: aPOST with the same target_domain, list_type, value_type and value returns 200 with the existing rule instead of creating a second one, and updates these fields:
label, when you send one that is not empty.extra, when you send one that is not empty.suppress_findings, when you send it.
VPN-Test.acme.com and vpn-test.acme.com are the same rule. To change target_domain, list_type, value_type or value, or to clear a label, delete the rule and create a new one.
Delete a rule
DELETE /api/hackerview/exclusions/{entry_id}/ deletes one rule by its id and returns 204. There is no bulk delete: to clear several rules, list them and delete each.
List rules
GET /api/hackerview/exclusions/ returns your organization’s rules, newest first.
Page by raising
page until next is null. The next and previous URLs point at an internal address, so don’t call them.
Apply rule changes
A rule change does not touch finished reports. To see it:1
Change the rules
Create, update or delete rules as above.
2
Generate the report again
Send Generate a report with the same
scan_uid and options. It uses no assessment allowance.3
Check what was removed
When the new report is
completed, read its exclusions_applied counters.email rule keeps that person out of the executive research. Rules you add later still apply to every report you build from that assessment.