Get PR Check detail

Returns the details and results of a PR check.

get/report/ciScans/{scan_id}/detail

Request

  • Base URL
    https://app.aikido.dev/api/public/v1
  • URL
    https://app.aikido.dev/api/public/v1/report/ciScans/{scan_id}/detail
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://app.aikido.io/api/oauth/token scopes: reports:read

Path parameters

scan_idinteger required

The unique ID of the PR check. Use the scan_id returned by List PR Checks.

Response

PR check details

pull_request_titlestring
pull_request_urlstring
branch_namestring
completed_scansstring[]
start_commit_idstring
end_commit_idstring
container_repo_idinteger
code_repo_idinteger
timestampinteger

Example response

{
  "pull_request_title": "Demo PR Check",
  "pull_request_url": "https://github.com/AikidoDemo/demo-repo/pull/12345",
  "branch_name": "demo-ci-scan",
  "changed_files": [
    {
      "file_path": "src/index.php",
      "previous_file_path": null,
      "renamed_without_changes": 0,
      "status": "modified"
    },
    {
      "file_path": "package-lock.json",
      "previous_file_path": null,
      "renamed_without_changes": 0,
      "status": "modified"
    }
  ],
  "completed_scans": [
    "dependency_scan",
    "sast_scan",
    "secrets_scan"
  ],
  "start_commit_id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2",
  "end_commit_id": "nvr9onnag1veuupnever9onnal3tud0wn",
  "container_repo_id": 1,
  "code_repo_id": 1,
  "timestamp": 1751595600,
  "issues_added": [
    {
      "title": "CVE-2024-1234 in lodash",
      "severity": 90,
      "programming_language": "JS",
      "file": "package-lock.json",
      "cve_id": "CVE-2024-1234",
      "cwe_classes": [
        "CWE-1321"
      ],
      "package_name": "lodash",
      "installed_version": "4.17.20",
      "patched_versions": [
        "4.17.21"
      ],
      "start_line": null,
      "end_line": null,
      "status": "open"
    },
    {
      "title": "SQL injection",
      "severity": 75,
      "programming_language": "PHP",
      "file": "src/index.php",
      "cve_id": null,
      "cwe_classes": null,
      "package_name": null,
      "installed_version": null,
      "patched_versions": [],
      "start_line": 42,
      "end_line": 45,
      "status": "ignored"
    }
  ],
  "issues_removed": [
    {
      "id": 101,
      "grouped_issue_id": 55,
      "title": "Exposed secret in src/config.php",
      "severity": 80,
      "programming_language": null,
      "file": "src/config.php",
      "cve_id": null,
      "cwe_classes": null,
      "package_name": null,
      "installed_version": null,
      "patched_versions": [],
      "start_line": 12,
      "end_line": 12
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.