Skip to main content
POST
/
api
/
v1
/
git-checks
/
skip
Skip Git Check
curl --request POST \
  --url https://api.example.com/api/v1/git-checks/skip \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "repo": "<string>",
  "commit_sha": "<string>",
  "environment": "<string>"
}
'
{
  "data": {
    "check_run_id": 12345678,
    "status": "skipped"
  },
  "error": null
}
Marks a GitHub check run as skipped for the specified repository and commit. This is useful when a commit does not require a test run (e.g. documentation-only changes) and you want to unblock a required status check.
The Empirical GitHub App must be installed on the target repository for this endpoint to work.

​
Request

​
Authorization
string
required
Bearer token for authentication. Format: Bearer <your-api-key>
​
repo
string
required
Full repository name in owner/repo format (e.g. acme/web-app).
​
commit_sha
string
required
The full Git commit SHA to skip the check for.
​
environment
string
The environment slug (e.g. production, staging). When provided, the check run will be named Empirical tests - <environment name>. When omitted, it defaults to Empirical tests.

​
Response

​
data.check_run_id
number
The GitHub check run ID that was created.
​
data.status
string
Always "skipped".
{
  "data": {
    "check_run_id": 12345678,
    "status": "skipped"
  },
  "error": null
}

​
Example

curl -X POST \
  https://dash.empirical.run/api/v1/git-checks/skip \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $EMPIRICALRUN_KEY" \
  -d '{
    "repo": "acme/web-app",
    "commit_sha": "4fe4a72397cfdaaccd033b656acd39ad7603294e"
  }'