GIgitguardian
GitHub Check Runs

Skip a GitHub check run

Changed on

Skip a GitHub check run that blocks a pull request, as the "Skip" buttons of the check run do on GitHub. This works even when the buttons are disabled in the workspace settings.

The check run is marked as skipped on GitHub. Its secret incidents and occurrences get the matching CHECK_RUN_SKIP_* tag, and an activity log entry is added on each incident. When the check run auto-heal playbook is active, the incidents are ignored with the same reason.

Get the check run id from the check run list, filtered on the secret incident.

Only Manager personal access tokens and service account tokens can skip a check run. Only a check run that failed on GitHub can be skipped.

post/v1/check-runs/{check_run_id}/skip

Request

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

Path parameters

check_run_idinteger required

The id of the GitHub check run

Request body

reason'false_positive' | 'low_risk' | 'test_credential' required

Example request

{
  "reason": "false_positive"
}

Response

Skipped check run.

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