Sign in
Findings

Create Finding

Create a user-authored custom finding.

post/api/v1/findings

Request body

annotationsobject

Arbitrary metadata attached to the finding; filterable by routing rules.

customSubTypestring

User-supplied sub-classification (e.g. "shadow_it"). Part of the dedup identity and filterable via FindingSearch.

dedupKeyPartsstring[] nullable

Caller-supplied dedup identity. The fingerprint is a domain-separated SHA-256 over ("custom", custom_sub_type, dedup_key_parts...) — see pkg/uhash; parts cannot collide regardless of their byte content. Two creates with the same parts collapse onto one finding. Must be non-empty and every part must be non-empty.

descriptionstring

Optional finding body (markdown by convention).

remediationDescriptionstring

Optional remediation guidance, used as the body of any task created from this finding.

severity'FINDING_SEVERITY_UNSPECIFIED' | 'FINDING_SEVERITY_INFO' | 'FINDING_SEVERITY_LOW' | 'FINDING_SEVERITY_MEDIUM' | 'FINDING_SEVERITY_HIGH' | 'FINDING_SEVERITY_CRITICAL'

Severity of the finding. Must be a defined, non-unspecified value.

tenantTargetC1ApiFindingV1TenantTarget

TenantTarget scopes a finding to the whole tenant. It carries no subject id; the finding's tenant is the scope.

Response

Successful response

Changes