Skip to main content
POST
/
api
/
v1
/
test-runs
/
skip
Skip Test Run
curl --request POST \
  --url https://dash.empirical.run/api/v1/test-runs/skip \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "repo": "<string>",
  "commit_sha": "<string>",
  "environment": "<string>"
}
'
{
  "data": {
    "check_run_id": 12345678,
    "status": "skipped"
  },
  "error": null
}
Marks a test run as skipped for the specified repository and commit. Useful when a commit does not require a test run (e.g. documentation-only changes) and you want to unblock a required Empirical status check on a PR. When the Empirical GitHub App is installed for the repo, this endpoint also creates a GitHub check run with conclusion skipped so a required Empirical check does not block the PR. If no Empirical GitHub App is installed for the repo, the request still succeeds and check_run_id will be null.
The previous path /api/v1/git-checks/skip is deprecated and now redirects here. Please update your callers.
{
  "data": {
    "check_run_id": 12345678,
    "status": "skipped"
  },
  "error": null
}

​
Example

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

Authorizations

​
Authorization
string
header
required

Project API key from the Empirical dashboard.

Body

application/json

Repository and commit to skip.

​
repo
string
required

Full repository name in owner/repo format.

​
commit_sha
string
required

Full Git commit SHA.

​
environment
string

Environment slug.

Response

Test run skipped. check_run_id is the ID of the GitHub check run created as skipped, or null if no GitHub reporter app is installed for the repo.

​
data
object
required