Lists Files with Errors

POST 
/code/api/v1/errors/files

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

List files with errors

Request

application/json

Body

required

CICDRunId double
authors string[]
branch stringnullable
categories Category (string)[]

Possible values: [IAM, Compute, Monitoring, Networking, Kubernetes, General, Storage, Secrets, Public, Vulnerabilities, Drift, BuildIntegrity, Licenses]

codeStatus CodeStatus (string)[]

Possible values: [hasFix]

excludeCategories Category (string)[]

Possible values: [IAM, Compute, Monitoring, Networking, Kubernetes, General, Storage, Secrets, Public, Vulnerabilities, Drift, BuildIntegrity, Licenses]

fileTypes FileType (string)[]

Possible values: [tf, json, yml, yaml, template, .checkov.baseline, hcl, Dockerfile, package.json, package-lock.json, bower.json, pom.xml, build.gradle, build.gradle.kts, gradle.properties, gradle-wrapper.properties, go.sum, go.mod, requirements.txt, METADATA, bicep, Pipfile.lock, Pipfile, yarn.lock, Gemfile, Gemfile.lock, gemspec, env, settings.py, main.py, application.py, config.py, app.js, config.js, dev.js, db.properties, application.properties, private.pem, privatekey.pem, index.php, config.php, config.xml, strings.xml, app.module.ts, environment.ts, tpl, tfvars, unknown, csproj, packages.config, Directory.Packages.props, paket.dependencies, paket.references, paket.lock, sln, config, composer.json, composer.lock]

repository stringrequired
repositoryId string
search object

options string[]required

Possible values: [path, code]

text stringrequired

title string

Possible values: [title, constructive_title, descriptive_title]

severities Severity (string)[]

Possible values: [INFO, LOW, MEDIUM, HIGH, CRITICAL]

sourceTypes SourceType (string)[]required

Possible values: [Github, Bitbucket, Gitlab, AzureRepos, cli, AWS, Azure, GCP, Docker, githubEnterprise, gitlabEnterprise, bitbucketEnterprise, terraformCloud, githubActions, circleci, codebuild, jenkins, tfcRunTasks, tfeRunTasks, admissionController, terraformEnterprise]

tags object[]
Array [
key stringrequired
value stringrequired
]
types Type (string)[]

Possible values: [Errors, Suppressed, Passed, Fixed, Awaiting Remediation]

Responses

200

Get errors files

application/json

Schema

Schema

data object[]required
Array [
awaitingRemediationCount doublerequired
errorsCount doublerequired
filePath stringrequired
fixedCount doublerequired
openErrorsCount doublerequired
passedCount doublerequired
suppressedErrorsCount doublerequired
type ErrorType (string)required
Possible values: [violation, dockerCve, packageCve, organization]
]

Example (from schema)

{
  "data": [
    {
      "awaitingRemediationCount": 0,
      "errorsCount": 0,
      "filePath": "string",
      "fixedCount": 0,
      "openErrorsCount": 0,
      "passedCount": 0,
      "suppressedErrorsCount": 0,
      "type": "violation"
    }
  ]
}

Example 1

{
  "data": [
    {
      "awaitingRemediationCount": 0,
      "errorsCount": 0,
      "filePath": "/terraform/gcp/instances.tf",
      "fixedCount": 0,
      "openErrorsCount": 0,
      "passedCount": 3,
      "suppressedErrorsCount": 0
    }
  ]
}

422

Request arguments validation error

500

Couldn't fetch files with errors

Loading...