Skip to main content

Lists all errors found in a given file path.​

List errors in files

Query Parameters
  • limit int32

    Possible values: >= 1 and <= 100

  • offset int32
Request Body required
  • CICDRunId double
  • authors string[]
  • branch string nullable
  • categories Category[]

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

  • codeStatus CodeStatus[]

    Possible values: [hasFix]

  • excludeCategories Category[]

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

  • filePath string required
  • fileTypes FileType[]

    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]

  • repository string required
  • repositoryId string
  • search object
  • options string[] required

    Possible values: [path, code]

  • text string required
  • title string

    Possible values: [title, constructive_title, descriptive_title]

  • severities Severity[]

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

  • sourceTypes SourceType[] required

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

  • tags object[]
  • Array [
  • key string required
  • value string required
  • ]
  • types Type[]

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

Responses

Get errors in file

Schema
  • data object[] required
  • Array [
  • author string required
  • commitHash string required
  • createdBy string
  • cves object[]
  • Array [
  • causePacakgeId string required
  • causePackageName string required
  • causePackageVersion string required
  • cveId string required
  • cvss double required
  • description string required
  • link string required
  • packageName string required
  • packageVersion string required
  • publishedDate date-time required
  • riskFactors string required
  • severity string required
  • status string required
  • vector string required
  • ]
  • date date-time required
  • errorId string required
  • errorLines double[] required
  • fileMetadataUuid string required
  • filePath string required
  • fixPath string required
  • fixedCode string required
  • fixes object[] required
  • Array [
  • code string
  • fixedCode string
  • id string required
  • inspectedKey string required
  • percent double required
  • recommenderType string required
  • times double required
  • ]
  • frameworkType string required
  • isFixable boolean
  • licenses object[]
  • Array [
  • id string required
  • license string required
  • packageId string required
  • packageName string required
  • packageVersion string required
  • parentId string required
  • status string required
  • ]
  • lines double[] required
  • metadataChecksMetadataPath string required
  • module object required
  • code string required
  • fixedCode string required
  • moduleFile string required
  • moduleReferences object[] required
  • Array [
  • code string required
  • displayPath string required
  • lines double[] required
  • name string required
  • path string required
  • ]
  • resourceCode string required
  • resourceId string required
  • resourceType string required
  • runtimeFrameworkType string
  • runtimeId string required
  • runtimeSourceId string required
  • scannerType string required
  • secrets object[]
  • Array [
  • author string required
  • commitHash string required
  • date date-time required
  • errorId string required
  • errorLines double[] required
  • fileMetadataUuid string required
  • filePath string required
  • fixPath string required
  • frameworkType string required
  • lines double[] required
  • metadataChecksMetadataPath string required
  • module object required
  • moduleFile string required
  • moduleReferences object[] required
  • Array [
  • code string required
  • displayPath string required
  • lines double[] required
  • name string required
  • path string required
  • ]
  • resourceCode string required
  • resourceFixCode string
  • resourceId string required
  • resourceType string required
  • resourceUuid string
  • runtimeFrameworkType string
  • runtimeId string required
  • runtimeSourceId string required
  • s3FilePath string
  • scannerType string required
  • sourceType SourceType required

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

  • status string required
  • variableCode string
  • variableFixCode string
  • variableRendering object required
  • code string required
  • lines double[] required
  • path string required
  • ]
  • selectedFix object nullable
  • code string
  • fixedCode string
  • id string required
  • inspectedKey string required
  • percent double required
  • recommenderType string required
  • times double required
  • sourceType SourceType required

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

  • status string required
  • variableRendering object required
  • code string required
  • fixedCode string required
  • lines double[] required
  • path string required
  • ]
  • hasNext boolean required
Loading...