Lists All Errors in File Path

POST 
/code/api/v1/errors/file

deprecated

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

List errors in files

Request

Query Parameters

limit int32

Possible values: >= 1 and <= 100

offset int32

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]

filePath stringrequired
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 in file

application/json

Schema

Schema

data object[]required
Array [
author stringrequired
category IncidentCategory (string)required
Possible values: [IAM, Logging, Monitoring, Networking, Kubernetes, General, Serverless, Elasticsearch, Storage, Secrets, Public, Vulnerabilities, Compute, VCS, BuildIntegrity, Licenses, Drift, Policy3D, Artifact Integrity Validation, Cider Kill Chain, Credential Hygiene, Data Protection, Dependency Chain Abuse, Dependency Chains, Flow Control Mechanisms, Input Validation, Patches & Updates, Pipeline-Based Access Controls (PBAC), Pipeline Flow Control, Poisoned Pipeline Execution (PPE), System Configuration, Supply Chain]
commitHash stringrequired
createdBy string
cves object[]
Array [
causePackageId stringrequired
causePackageName stringrequired
causePackageVersion stringrequired
cveId stringrequired
cveStatus stringrequired
cvss doublerequired
description stringrequired
errorLines double[]
fixVersion stringrequired
imageName string
link stringrequired
packageName stringrequired
packageVersion stringrequired
publishedDate date-timerequired
riskFactors stringrequired
severity stringrequired
status stringrequired
uuid stringrequired
vector stringrequired
violationId stringrequired
]
date date-timerequired
errorId stringrequired
errorLines double[]required
fileMetadataUuid stringrequired
filePath stringrequired
fixPath stringrequired
fixedCode stringrequired
fixes object[]required
Array [
code string
fixedCode string
id stringrequired
inspectedKey stringrequired
percent doublerequired
recommenderType stringrequired
times doublerequired
]
frameworkType stringrequired
isFixable boolean
licenses object[]
Array [
id stringrequired
license stringrequired
packageId stringrequired
packageName stringrequired
packageVersion stringrequired
parentId stringrequired
status stringrequired
]
lines double[]required
metadataChecksMetadataPath stringrequired
module objectrequired
code stringrequired
fixedCode stringrequired
moduleFile stringrequired
moduleReferences object[]required
Array [
code stringrequired
displayPath stringrequired
lines double[]required
name stringrequired
path stringrequired
]
resourceCode stringrequired
resourceId stringrequired
resourceType stringrequired
runtimeFrameworkType string
runtimeId stringrequired
runtimeSourceId stringrequired
scannerType stringrequired
secretValidationStatus SecretValidationStatus (string)required
Possible values: [Privileged, Valid, Invalid, Unknown, Unavailable]
secrets object[]
Array [
author stringrequired
category IncidentCategory (string)required
Possible values: [IAM, Logging, Monitoring, Networking, Kubernetes, General, Serverless, Elasticsearch, Storage, Secrets, Public, Vulnerabilities, Compute, VCS, BuildIntegrity, Licenses, Drift, Policy3D, Artifact Integrity Validation, Cider Kill Chain, Credential Hygiene, Data Protection, Dependency Chain Abuse, Dependency Chains, Flow Control Mechanisms, Input Validation, Patches & Updates, Pipeline-Based Access Controls (PBAC), Pipeline Flow Control, Poisoned Pipeline Execution (PPE), System Configuration, Supply Chain]
commitHash stringrequired
date date-timerequired
errorId stringrequired
errorLines double[]required
fileMetadataUuid stringrequired
filePath stringrequired
fixPath stringrequired
frameworkType stringrequired
lines double[]required
metadataChecksMetadataPath stringrequired
module objectrequired
moduleFile stringrequired
moduleReferences object[]required
Array [
code stringrequired
displayPath stringrequired
lines double[]required
name stringrequired
path stringrequired
]
resourceCode stringrequired
resourceFixCode string
resourceId stringrequired
resourceType stringrequired
resourceUuid string
runtimeFrameworkType string
runtimeId stringrequired
runtimeSourceId stringrequired
s3FilePath string
scannerType stringrequired
secretValidationStatus SecretValidationStatus (string)required
Possible values: [Privileged, Valid, Invalid, Unknown, Unavailable]
sourceType 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]
status stringrequired
variableCode string
variableFixCode string
variableRendering objectrequired
code stringrequired
lines double[]required
path stringrequired
]
selectedFix objectnullable
code string
fixedCode string
id stringrequired
inspectedKey stringrequired
percent doublerequired
recommenderType stringrequired
times doublerequired
sourceType 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]
status stringrequired
variableRendering objectrequired
code stringrequired
fixedCode stringrequired
lines double[]required
path stringrequired
]
hasNext booleanrequired

Example (from schema)

{
  "data": [
    {
      "author": "string",
      "category": "IAM",
      "commitHash": "string",
      "createdBy": "string",
      "cves": [
        {
          "causePackageId": "string",
          "causePackageName": "string",
          "causePackageVersion": "string",
          "cveId": "string",
          "cveStatus": "string",
          "cvss": 0,
          "description": "string",
          "errorLines": [
            0
          ],
          "fixVersion": "string",
          "imageName": "string",
          "link": "string",
          "packageName": "string",
          "packageVersion": "string",
          "publishedDate": "2024-04-23T19:45:33.732Z",
          "riskFactors": "string",
          "severity": "string",
          "status": "string",
          "uuid": "string",
          "vector": "string",
          "violationId": "string"
        }
      ],
      "date": "2024-04-23T19:45:33.732Z",
      "errorId": "string",
      "errorLines": [
        0
      ],
      "fileMetadataUuid": "string",
      "filePath": "string",
      "fixPath": "string",
      "fixedCode": "string",
      "fixes": [
        {
          "code": "string",
          "fixedCode": "string",
          "id": "string",
          "inspectedKey": "string",
          "percent": 0,
          "recommenderType": "string",
          "times": 0
        }
      ],
      "frameworkType": "string",
      "isFixable": true,
      "licenses": [
        {
          "id": "string",
          "license": "string",
          "packageId": "string",
          "packageName": "string",
          "packageVersion": "string",
          "parentId": "string",
          "status": "string"
        }
      ],
      "lines": [
        0
      ],
      "metadataChecksMetadataPath": "string",
      "module": {
        "code": "string",
        "fixedCode": "string",
        "moduleFile": "string",
        "moduleReferences": [
          {
            "code": "string",
            "displayPath": "string",
            "lines": [
              0
            ],
            "name": "string",
            "path": "string"
          }
        ]
      },
      "resourceCode": "string",
      "resourceId": "string",
      "resourceType": "string",
      "runtimeFrameworkType": "string",
      "runtimeId": "string",
      "runtimeSourceId": "string",
      "scannerType": "string",
      "secretValidationStatus": "Privileged",
      "secrets": [
        {
          "author": "string",
          "category": "IAM",
          "commitHash": "string",
          "date": "2024-04-23T19:45:33.732Z",
          "errorId": "string",
          "errorLines": [
            0
          ],
          "fileMetadataUuid": "string",
          "filePath": "string",
          "fixPath": "string",
          "frameworkType": "string",
          "lines": [
            0
          ],
          "metadataChecksMetadataPath": "string",
          "module": {
            "moduleFile": "string",
            "moduleReferences": [
              {
                "code": "string",
                "displayPath": "string",
                "lines": [
                  0
                ],
                "name": "string",
                "path": "string"
              }
            ]
          },
          "resourceCode": "string",
          "resourceFixCode": "string",
          "resourceId": "string",
          "resourceType": "string",
          "resourceUuid": "string",
          "runtimeFrameworkType": "string",
          "runtimeId": "string",
          "runtimeSourceId": "string",
          "s3FilePath": "string",
          "scannerType": "string",
          "secretValidationStatus": "Privileged",
          "sourceType": "Github",
          "status": "string",
          "variableCode": "string",
          "variableFixCode": "string",
          "variableRendering": {
            "code": "string",
            "lines": [
              0
            ],
            "path": "string"
          }
        }
      ],
      "selectedFix": {
        "code": "string",
        "fixedCode": "string",
        "id": "string",
        "inspectedKey": "string",
        "percent": 0,
        "recommenderType": "string",
        "times": 0
      },
      "sourceType": "Github",
      "status": "string",
      "variableRendering": {
        "code": "string",
        "fixedCode": "string",
        "lines": [
          0
        ],
        "path": "string"
      }
    }
  ],
  "hasNext": true
}

Example 1

{
  "data": [
    {
      "author": "author",
      "category": "IAM",
      "commitHash": "5c6b5d60",
      "createdBy": "checkov_terraform",
      "errorId": "BC_AWS_S3_14",
      "errorLines": [],
      "fileMetadataUuid": "de707daa-2ef3-40e1-8bbf-5e39f86b927e",
      "filePath": "/terraform/aws/s3.tf",
      "fixPath": "checkov/yourname/yourGithubName/yourRepo/master/fixes/BC_AWS_S3_14/aws_s3_bucket.data/terraform/aws/s3.tf",
      "fixedCode": "resource \"aws_s3_bucket\" \"data\" { \n  # bucket is public \n bucket        = \"$\n{local.resource_prefix.value}-data\" \n force_destroy = true \n tags = merge({ \n  Name        = \"${local.resource_prefix.value}-data\" \n Environment = local.resource_prefix.value \n }) \n server_side_encryption_configuration { \n rule { \n apply_server_side_encryption_by_default { \n sse_algorithm = \"AES256\" \n } \n } \n }",
      "fixes": [],
      "frameworkType": "Terraform",
      "isFixable": true,
      "lines": [
        1,
        21
      ],
      "metadataChecksMetadataPath": "checkov/yourname/yourGithubName/yourRepo/master/checkov_results/terraform/checks_metadata.json",
      "resourceCode": "resource \"aws_s3_bucket\" \"data\" { \n  # bucket is public \n bucket        = \"$\n{local.resource_prefix.value}-data\" \n force_destroy = true \n tags = merge({ \n  Name        = \"${local.resource_prefix.value}-data\" \n Environment = local.resource_prefix.value \n })",
      "resourceId": "/terraform/aws/s3.tf:aws_s3_bucket.data",
      "resourceType": "aws_s3_bucket.data",
      "runtimeFrameworkType": null,
      "runtimeId": null,
      "runtimeSourceId": null,
      "scannerType": "Checkov",
      "secretValidationStatus": "Valid",
      "selectedFix": null,
      "sourceType": "Github",
      "status": "OPEN"
    }
  ],
  "hasNext": true
}

422

Request arguments validation error

Loading...