Batch Get Findings

codegurusecurity_batch_get_findings

R Documentation

Returns a list of requested findings from standard scans

Description

Returns a list of requested findings from standard scans.

Usage

codegurusecurity_batch_get_findings(findingIdentifiers)

Arguments

findingIdentifiers

[required] A list of finding identifiers. Each identifier consists of a scanName and a findingId. You retrieve the findingId when you call get_findings.

Value

A list with the following syntax:

list(
  failedFindings = list(
    list(
      errorCode = "DUPLICATE_IDENTIFIER"|"ITEM_DOES_NOT_EXIST"|"INTERNAL_ERROR"|"INVALID_FINDING_ID"|"INVALID_SCAN_NAME",
      findingId = "string",
      message = "string",
      scanName = "string"
    )
  ),
  findings = list(
    list(
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      description = "string",
      detectorId = "string",
      detectorName = "string",
      detectorTags = list(
        "string"
      ),
      generatorId = "string",
      id = "string",
      remediation = list(
        recommendation = list(
          text = "string",
          url = "string"
        ),
        suggestedFixes = list(
          list(
            code = "string",
            description = "string"
          )
        )
      ),
      resource = list(
        id = "string",
        subResourceId = "string"
      ),
      ruleId = "string",
      severity = "Critical"|"High"|"Medium"|"Low"|"Info",
      status = "Closed"|"Open"|"All",
      title = "string",
      type = "string",
      updatedAt = as.POSIXct(
        "2015-01-01"
      ),
      vulnerability = list(
        filePath = list(
          codeSnippet = list(
            list(
              content = "string",
              number = 123
            )
          ),
          endLine = 123,
          name = "string",
          path = "string",
          startLine = 123
        ),
        id = "string",
        itemCount = 123,
        referenceUrls = list(
          "string"
        ),
        relatedVulnerabilities = list(
          "string"
        )
      )
    )
  )
)

Request syntax

svc$batch_get_findings(
  findingIdentifiers = list(
    list(
      findingId = "string",
      scanName = "string"
    )
  )
)