Skip to main content
POST
Dismiss Findings

Body

application/json
platform
enum<string>
required

Git platform of the organization

Available options:
github,
gitlab,
bitbucket,
azure_devops
org
string
required

Organization / workspace slug

repo
string
required

Repository full name the findings belong to

Example:

"owner/repository"

analysis_type
enum<string>
required

Scanner the findings come from. raw.analysis_type from the Hotlist API maps directly (security is accepted as an alias of sast).

Available options:
sast,
sca,
secrets,
iac
dismiss_keys
string[]
required

Finding identifiers to dismiss — one request dismisses any number of findings in one repo. Take them verbatim from raw.dismiss_key of the Hotlist API (/api/security/hotlist/findings), or build them from the per-repo results:

  • scapackage@version dismisses every advisory of the package; package@version::<manifest relative_path>::<cve_id> dismisses one advisory.
  • sast<file_path>||::||<context_code_block>||::||<test_id>.
  • secrets<file_path>||::||<hashed_secret>:occurrence:<n>||::||<type> (n is the 0-based index among identical secrets in that file).
  • iac<file_path>||::||<check_id>||::||<start_line>-<end_line>.
Minimum array length: 1
Example:
github_base_url
string

Self-hosted instance URL (also gitlab_base_url / bitbucket_base_url / azure_devops_base_url). Defaults to the cloud host.

Example:

"https://github.com"

reason
string

Shown as the dismissal reason in the dashboard.

Example:

"This alert is inaccurate or incorrect"

comment
string

Free-text note stored with the dismissal.

dismissed_by
string

Attribution recorded on the dismissal; defaults to api.

Example:

"sec-automation@example.com"

Response

Findings dismissed

status
string
Example:

"success"

dismissed
integer

Number of dismiss keys written.

Example:

2