Get Scan Details

Retrieve the details of a scan including the associated deployment, repository, and commit information.

External Documentation

To learn more, visit the SemGrep documentation.

Parameters

Parameter	Description
Deployment ID	The deployment ID (numeric). Can be obtained by the Get Deployment action, or in your Settings in the Web UI.
Scan ID	The scan ID to retrieve details for.

Example Output

{
    "id": 123,
    "deployment_id": 120,
    "repository_id": 1234567,
    "started_at": "2023-11-18T23:28:12.391807Z",
    "completed_at": "2023-11-18T23:31:12.391807Z",
    "meta": {
        "on": "pull_request",
        "branch": "refs/heads/main",
        "commit": "94c5be1312a9da03b7c4bfcc1c50b4379c83412",
        "config": "r/python",
        "repo_url": "https://github.com/semgrep/semgrep",
        "ci_job_url": "https://github.com/semgrep/semgrep/actions/runs/12345",
        "repository": "semgrep/semgrep",
        "commit_title": "fix(feature): Added XYZ component",
        "ignored_files": [
            "/test/"
        ],
        "pull_request_id": "12345",
        "pull_request_title": "fix(feature): Added XYZ component",
        "commit_author_name": "Sven Greppe",
        "commit_author_image_url": "https://github.com/link/to/avatar.png",
        "commit_author_email": "sven.greppe@semgrep.com",
        "commit_author_username": "SvenGreppe",
        "pull_request_author_username": "SvenGreppe",
        "pull_request_author_image_url": "https://github.com/link/to/avatar.png"
    },
    "stats": {
        "findings": 5,
        "total_time": 100
    },
    "enabled_products": [
        "secrets"
    ]
}

Workflow Library Example

Get Scan Details with Semgrep and Send Results Via Email

Preview this Workflow on desktop