Reporter icon

Reporter

Interact with Reporter API

Actions120

Finding → Create a finding

AI-generated

Summary

Create a new finding within a specified assessment and assessment section, defining its details such as title, vulnerability status, review status, publication status, and various optional attributes.

Inputs

  • Assessment id (required) — The ID of the assessment under which to create the finding.
  • Title (required) — The title of the finding (max 191 characters).
  • Assessment section id (required) — The ID of the assessment section within the assessment where the finding will be placed. The section must belong to the assessment and allow findings.
  • Is vulnerability (required) — Boolean indicating if the finding is a vulnerability with associated severity metrics.
  • Review status (required) — The current review status of the finding; valid options are Draft, Under Review, Revision Requested, or Approved.
  • Is published (required) — Boolean indicating if the finding is published.
  • Additional Fields — Optional additional fields such as tool findings linked, resolvers, severity metrics, severity (required if not vulnerability), draft documents, assignees, teams, remediation status (only if vulnerability), priority, complexity, recommended action, targets, found at date, description, risk, recommendation, proof, references, classifications, and test cases.
  • Custom Fields — Custom field values to set for the finding using the node's custom fields interface.

Output shape

a single record representing the newly created finding with all submitted and assigned properties

The operation requires certain fields depending on whether the finding is marked as a vulnerability. Severity metrics are required if the finding is a vulnerability; severity is required if it is not. Parent IDs (assessment and assessment section) must be valid and consistent. The response returns the created finding resource directly.

Links

Discussion