How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GitHub Runs API

The Runs API from GitHub — 22 operation(s) for runs.

GitHub Runs API is one of 350 APIs that GitHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Runs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and an API reference.

This API exposes 26 operations across 22 paths, and defines 24 schemas. It is described by OpenAPI 3.2.0, at version 1.1.4.

Requests are made against 2 base URLs: {protocol}://{hostname}/api/v3, {protocol}://{hostname}.

26 operations 22 paths 24 schemas 2 DELETE17 GET1 PATCH6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.1.4
Base URL
https://api.github.com
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

GitHub Runs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerHttpAuthentication).

  • bearerHttpAuthentication — Bearer Token

Paths & Operations 26

Across 22 paths, the API surfaces 26 operations — 2 DELETE, 17 GET, 1 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Runs 26
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/approvals
GitHub Get the Review History Forworkflow Run
getTheReviewHistoryForworkflowRun 3 params → 200
GET
/repos/{owner}/{repo}/actions/jobs/{job_id}
GitHub Get Job for Workflow Run
getJobForWorkflowRun 6 params → 200
GET
/repos/{owner}/{repo}/actions/jobs/{job_id}/logs
GitHub Download Job Logs for Workflow Run
downloadJobLogsForWorkflowRun 6 params → 302
POST
/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun
GitHub Re-run Job from Workflow Run
rerunJobFromWorkflowRun 6 params body → 201403
GET
/repos/{owner}/{repo}/actions/runs
GitHub List Workflow Runs for Repository
listWorkflowRunsForRepository 15 params → 200
GET
/repos/{owner}/{repo}/actions/runs/{run_id}
GitHub Get Workflow Run
getWorkflowRun 7 params → 200
DELETE
/repos/{owner}/{repo}/actions/runs/{run_id}
GitHub Delete Workflow Run
deleteWorkflowRun 6 params → 204
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts
GitHub List Workflow Run Artifacts
listWorkflowRunArtifacts 9 params → 200
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}
GitHub Get Workflow Run Attempt
getWorkflowRunAttempt 8 params → 200
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs
GitHub List Jobs for Workflow Run Attempt
listJobsForWorkflowRunAttempt 9 params → 200404
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs
GitHub Download Workflow Run Attempt Logs
downloadWorkflowRunAttemptLogs 7 params → 302
POST
/repos/{owner}/{repo}/actions/runs/{run_id}/cancel
GitHub Cancel Workflow Run
cancelWorkflowRun 6 params → 202409
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/jobs
GitHub List Jobs for Workflow Run
listJobsForWorkflowRun 9 params → 200
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/logs
GitHub Download Workflow Run Logs
downloadWorkflowRunLogs 6 params → 302
DELETE
/repos/{owner}/{repo}/actions/runs/{run_id}/logs
GitHub Delete Workflow Run Logs
deleteWorkflowRunLogs 6 params → 204403500
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments
GitHub Get Pending Deployments for Workflow Run
getPendingDeploymentsForWorkflowRun 6 params → 200
POST
/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments
GitHub Review Pending Deployments for Workflow Run
reviewPendingDeploymentsForWorkflowRun 6 params body → 200
POST
/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs
GitHub Re-run Failed Jobs from Workflow Run
rerunFailedJobsFromWorkflowRun 6 params body → 201
GET
/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs
GitHub List Workflow Runs for Workflow
listWorkflowRunsForWorkflow 16 params → 200
POST
/repos/{owner}/{repo}/check-runs
GitHub Create Check Run
createCheckRun 5 params body → 201
GET
/repos/{owner}/{repo}/check-runs/{check_run_id}
GitHub Get Check Run
getCheckRun 6 params → 200
PATCH
/repos/{owner}/{repo}/check-runs/{check_run_id}
GitHub Update Check Run
updateCheckRun 6 params body → 200
GET
/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations
GitHub List Check Run Annotations
listCheckRunAnnotations 8 params → 200
POST
/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest
GitHub Rerequest Check Run
rerequestCheckRun 6 params → 201403404422
GET
/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs
GitHub List Check Runs in Check Suite
listCheckRunsInCheckSuite 11 params → 200
GET
/repos/{owner}/{repo}/commits/{ref}/check-runs
GitHub List Check Runs for Git Reference
listCheckRunsForGitReference 12 params → 200

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are minimal-repository (87 properties), workflow-run (36 properties), job (23 properties), nullable-simple-user (21 properties). Each schema is shown below with its type and property counts.

simple-user
object
A GitHub user.
21 properties 18 required
environment-approvals
object
An entry in the reviews log for environment deployments
4 properties 4 required
pending-deployment
object
Details of a deployment that is waiting for protection rules to pass
5 properties 5 required
code-of-conduct
object
Code Of Conduct
5 properties 4 required
minimal-repository
object
Minimal Repository
87 properties 46 required
workflow-run
object
An invocation of a workflow
36 properties 26 required
team
object
Groups of organization members that gives permissions on specified repositories.
13 properties 11 required
security-and-analysis
object
3 properties
simple-user_2
object
GitHub user.
21 properties 18 required
nullable-integration
object
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They…
17 properties 11 required
deployment-reviewer-type
string
The type of reviewer.
basic-error
object
Basic Error
4 properties
referenced-workflow
object
workflow referenced/reused by the initial caller workflow
3 properties 2 required
pull-request-minimal
object
5 properties 5 required
nullable-team-simple
object
Groups of organization members that gives permissions on specified repositories.
12 properties 10 required
empty-object
object
An object without any properties.
artifact
object
An artifact
11 properties 10 required
job
object
Information of a job execution in a workflow run
23 properties 21 required
deployment
object
request for a specific ref(branch,sha,tag) to be deployed
18 properties 14 required
nullable-simple-commit
object
commit.
6 properties 6 required
nullable-simple-user
object
GitHub user.
21 properties 18 required
deployment-simple
object
deployment created as the result of an Actions check run from a workflow that references an environment
14 properties 10 required
check-run
object
check performed on the code of a given code change
17 properties 16 required
check-annotation
object
Check Annotation
10 properties 10 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

github-runs-api-openapi.yml Raw ↑

Other APIs GitHub publishes across the network.

GitHub Events API
GitHub Feeds API
GitHub Gists API
GitHub Issues API
GitHub Licenses API
GitHub Markdown API
GitHub Meta API
GitHub Notifications API
GitHub Octocat API
GitHub Projects API
GitHub Repos API
GitHub Search API
Where this information came from

This is an independent, third-party profile of GitHub Runs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.