v1

latestOpenAPI 3.0.32026-07-26233989.2 KB

Analysis

Get IaC Scan Results

Retrieves Infrastructure as Code (IaC) security scanning results for a specific repository and commit

post/api/analysis/results/iac

Request body

repostring required

Repository identifier (format varies by service)

commit_idstring

Git commit SHA or identifier. Either commit_id or branch is required. If both are provided, commit_id takes precedence.

branchstring

Git branch name. When provided without commit_id, the service resolves the latest commit from scan history for this branch. Either commit_id or branch is required.

access_tokenstring required

Authentication token for the service

service'github' | 'azuredevops' | 'gitlab' | 'bitbucket' required

Version control service provider

gitlab_base_urlstring

Base URL for the service (optional for GitHub, required for GitLab)

Example request

{
  "repo": "owner/repository",
  "commit_id": "abc123def456",
  "branch": "main",
  "access_token": "ghp_xxxxxxxxxxxx",
  "service": "github",
  "gitlab_base_url": "https://gitlab.com"
}

Response

IaC scan results retrieved successfully

Example response

{
  "results": [
    {
      "check_type": "terraform",
      "results": {
        "failed_checks": [
          {
            "bc_check_id": "BC_AWS_NETWORKING_31",
            "check_id": "CKV_AWS_23",
            "check_name": "Ensure every security group and rule has a description",
            "file_path": "/owner/repository/abc123def456/terraform/main.tf",
            "file_line_range": [
              2,
              25
            ],
            "check_class": "checkov.terraform.checks.resource.aws.SecurityGroupRuleDescription",
            "code_block": [
              [
                2,
                "resource \"aws_security_group\" \"web\" {\n"
              ],
              [
                3,
                "  name_prefix = \"web-sg\"\n"
              ]
            ],
            "resource": "aws_security_group.web",
            "start_line": 2,
            "end_line": 25
          }
        ]
      }
    }
  ]
}