GIgitguardian
GitHub Check Runs

List GitHub check runs

Changed on

List the GitHub check runs that GitGuardian ran on pull requests, from the most recent to the oldest.

Filter on incident_id to get the check runs that reported a secret incident. Then skip a blocking one with the skip endpoint.

Only Manager personal access tokens and service account tokens can list check runs.

get/v1/check-runs

Request

  • Base URL
    https://api.gitguardian.com
  • URL
    https://api.gitguardian.com/v1/check-runs
  • Auth
    HTTP bearer

Query parameters

cursorstring

Pagination cursor.

per_pageinteger

Number of items to list per page.

ordering'id' | '-id' | 'created_at' | '-created_at'

Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'. Default: -id.

incident_idinteger
Example:3759

Keep the check runs that reported an occurrence of this secret incident.

Response

Check Run List

idinteger
created_atstring date-time
repository_full_namestring

Full name of the GitHub repository

commit_shastring

SHA of the head commit the check run evaluated

github_status'queued' | 'in_progress' | 'completed'

Status of the check run on GitHub

github_conclusion'action_required' | 'cancelled' | 'failure' | 'neutral' | 'success' | 'skipped' | 'stale' | 'timed_out' nullable

Conclusion of the check run on GitHub. Null while the check run is running.

ignored_atstring date-time nullable

Date the check run was skipped

ignore_reason'false_positive' | 'low_risk' | 'test_credential' | 'skipped_from_fork' nullable

Reason given when the check run was skipped. skipped_from_fork is set when the check run of a pull request from a fork is skipped on GitHub.

Example response

[
  {
    "id": 5412,
    "created_at": "2026-10-05T12:30:12.402518Z",
    "repository_full_name": "gitguardian/demo",
    "commit_sha": "d670460b4b4aece5915caf5c68d12f560a9fe3e4",
    "pull_requests": [
      {
        "number": 42,
        "state": "OPEN",
        "head_branch": "feature/add-config",
        "base_branch": "main"
      }
    ],
    "github_status": "completed",
    "github_conclusion": "skipped",
    "ignored_at": "2026-10-05T12:40:55.662949Z",
    "ignore_reason": "false_positive"
  }
]

Changes