Skip to main content

Deployment Scan Finding

View as Markdown

A single security scan finding for an app deployment. Findings are produced when a deployment's source code is scanned, and their triage status is preserved across re-scans of the same deployment.

AppDeploymentScanFinding object​

A single security scan finding for an app deployment. Findings are produced when a deployment's source code is scanned, and their triage status is preserved across re-scans of the same deployment.

namestringBeta

The resource name of the finding, in the form apps/{app}/deployments/{deployment}/scanFindings/{finding_id}.

Example: apps/my-app/deployments/01ef0bda89f21f08a8351f41e4a9b948/scanFindings/abc123

statusstringBeta

The triage status of the finding. This is the only client-writable field; set it to resolve or ignore a finding.

Values:

  • SCAN_FINDING_STATUS_IN_PROGRESS
  • SCAN_FINDING_STATUS_RESOLVED
  • SCAN_FINDING_STATUS_IGNORED
finding_idstringBetaOutput only

The stable id of the finding (the last segment of name), derived from the rule, file, and line so the same issue keeps its triage status across re-scans.

rule_idstringBetaOutput only

The scanner rule that produced the finding.

file_pathstringBetaOutput only

The app-relative path of the file the finding was reported in.

lineint32BetaOutput only

The line number the finding was reported at.

messagestringBetaOutput only

A human-readable description of the finding.

severitystringBetaOutput only

The severity reported by the scanner.

Values:

  • SCAN_FINDING_SEVERITY_INFO
  • SCAN_FINDING_SEVERITY_WARNING
  • SCAN_FINDING_SEVERITY_ERROR
scanner_typestringBetaOutput only

The scanner that produced the finding.

Values:

  • SCAN_FINDING_SCANNER_TYPE_SEMGREP

Get an app deployment scan finding Beta​

GET /api/2.0/{name=apps/*/deployments/*/scanFindings/*}

Retrieves a single security scan finding for an app deployment.

API scopes: apps

Parameters​

namestringRequiredpath

The resource name of the finding, in the form apps/{app}/deployments/{deployment}/scanFindings/{finding_id}.

Example: apps/my-app/deployments/01ef0bda89f21f08a8351f41e4a9b948/scanFindings/abc123

Response​

Returns the AppDeploymentScanFinding object.

List app deployment scan findings Beta​

GET /api/2.0/{parent=apps/*/deployments/*}/scanFindings

Lists the security scan findings for an app deployment.

API scopes: apps

Parameters​

parentstringRequiredpath

The parent deployment whose findings to list, in the form apps/{app}/deployments/{deployment}.

Example: apps/my-app/deployments/01ef0bda89f21f08a8351f41e4a9b948

page_sizeint32query

Upper bound for the number of findings returned.

page_tokenstringquery

Pagination token to request the next page. Requests the first page if absent.

Response​

Returns a list of AppDeploymentScanFinding objects.

Update an app deployment scan finding Beta​

PATCH /api/2.0/{name=apps/*/deployments/*/scanFindings/*}

1 more path

PATCH /api/2.0/apps-ui/{name=apps/*/deployments/*/scanFindings/*}

Updates the triage status (resolved / ignored / in-progress) of a single scan finding.

API scopes: apps

Parameters​

namestringRequiredpath

The resource name of the finding, in the form apps/{app}/deployments/{deployment}/scanFindings/{finding_id}.

Example: apps/my-app/deployments/01ef0bda89f21f08a8351f41e4a9b948/scanFindings/abc123

update_maskstringRequiredquery

The fields to update. Must be exactly status, the only updatable field on a scan finding.

Request body​

The finding to update. name identifies the finding and status is the new triage status.

statusstring

The triage status of the finding. This is the only client-writable field; set it to resolve or ignore a finding.

Values:

  • SCAN_FINDING_STATUS_IN_PROGRESS
  • SCAN_FINDING_STATUS_RESOLVED
  • SCAN_FINDING_STATUS_IGNORED

Response​

Returns the AppDeploymentScanFinding object.