Hanzo
OpenapiSecurity

Is the org's findings — rule, severity, path, line, masked preview and…

Is the org's findings — rule, severity, path, line, masked preview and fingerprint — newest first, across scans or within one.

GET /v1/security/findings

Addresshttps://api.hanzo.ai/v1/security/findings
MethodGET
Operationget_security_findings
AuthAuthorization: Bearer $HANZO_API_KEY

Is the org's findings — rule, severity, path, line, masked preview and fingerprint — newest first, across scans or within one.

A minSeverity outside critical|high|medium|low is refused rather than quietly ignored, so a filter typo cannot read as "no findings". Strictly org-scoped, and a caller with no validated org is refused.

Request

3 fields.

FieldInTypeRequiredDescription
scanIdquerystringScanID narrows to a single scan.
minSeverityquerystringMinSeverity drops everything below that rank: critical, high, medium or low.
limitqueryintegerLimit caps the page.

Response

StatusBodyMeaning
200findingListok

200 body — 11 fields.

FieldInTypeAlwaysDescription
databodyfindingView[]Data is the caller org's findings, newest first.
data[].createdAtbodyintegerCreatedAt is when the finding was recorded, in Unix milliseconds.
data[].fingerprintbodystringFingerprint is the SHA-256 of the raw secret.
data[].idbodystringID addresses this finding.
data[].linebodyintegerLine is where in that file.
data[].pathbodystringPath is the file the secret was found in.
data[].previewbodystringPreview is the secret MASKED — first and last characters kept, the middle starred — so a reviewer can recognise it without it being disclosed.
data[].ruleIdbodystringRuleID is the detection rule that fired.
data[].ruleNamebodystringRuleName is that rule's human name.
data[].scanIdbodystringScanID is the scan that produced it.
data[].severitybodystringSeverity ranks the finding: critical, high, medium or low.

Failure carries the platform error shape — see Errors.

Examples

hanzo security findings list

Security API · All Hanzo APIs · Interactive reference

How is this guide?

On this page