Skip to content
DashboardWebsite

Quick Start: Triage a Finding

Just want to do it in the dashboard? See the guide: Dismiss a false positive.

A finding record stores its triage status for the same resource and rule across rescans. Use the dashboard or API to change that status.

In the dashboard: Analysis → Findings, open the status menu on a row. Or use the API:

Terminal window
curl -X PATCH -H "X-API-Key: $OPENTREMOR_API_KEY" http://localhost:8000/v1/findings/a3f1c2d4.../TFSEC-040 \
-H "Content-Type: application/json" \
-d '{"status": "suppressed", "note": "accepted risk — internal tool"}'

You can set status to open, needs_review, acknowledged, suppressed, or false_positive. The system sets closed when a completed revision no longer reports the finding. See Findings for how to list and filter finding records.

When you set a verdict status, OpenTremor records it in the review-feedback log for the rule. The Rule Health page aggregates this feedback, which can also steer later analyses.

Add an optional reason_code to explain the decision:

Terminal window
curl -X PATCH -H "X-API-Key: $OPENTREMOR_API_KEY" http://localhost:8000/v1/findings/a3f1c2d4.../TFSEC-040 \
-H "Content-Type: application/json" \
-d '{"status": "suppressed", "reason_code": "accepted_risk", "note": "internal tool, no public route"}'

Valid reason_code values are false_positive, accepted_risk, fixed, not_applicable_here, and other.

For suppressed, the reason distinguishes “this finding is wrong” from “this finding is real, but we accept the risk.” Without a reason, OpenTremor records the verdict as unclear. For acknowledged and false_positive, the status already gives the verdict; the reason adds context. The dashboard offers a reason in its status dialog. The API accepts reason_code as optional.

If the finding came from a GitHub pull request, the API call also refreshes that pull request’s commit status. Acknowledging the last finding holding a check can make it pass without another push. See Clearing a held check.

Record a verdict in a pull-request comment

Section titled “Record a verdict in a pull-request comment”

If the finding came from a GitHub pull request, you can record a verdict in a new pull-request comment or a reply to OpenTremor’s report comment:

@opentremor false-positive TFSEC-040: internal tool, no public route

The command records feedback for the analysis under review. The verdict word supplies the reason: false-positive maps to false_positive, and accept-risk maps to accepted_risk. Include the rule ID, except with missed, which describes something no rule caught. If a command names a rule that the analysis does not contain, OpenTremor records the verdict as unclear. The default @opentremor prefix can be changed per deployment.

Post a new comment or reply; do not edit OpenTremor’s report comment. OpenTremor rewrites that comment after each push, so your edit would be overwritten. See How a reply finds its analysis and Review Feedback Loop for how replies are matched and which verdicts are supported.


See Authentication to set up a multi-tenant deployment, or Review Feedback Loop to learn how OpenTremor records verdicts and uses them.