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 Actions Workflow Runs API

Manage and monitor workflow run executions

GitHub Actions Workflow Runs API is one of 11 APIs that GitHub Actions publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 9 JSON Schema definitions.

Tagged areas include Workflow Runs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, an API reference, a changelog, and 9 JSON Schemas.

This API exposes 17 operations across 14 paths, and defines 8 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.github.com.

17 operations 14 paths 8 schemas 2 DELETE8 GET7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.github.com
Authentication
HTTP Bearer, HTTP Bearer
License
Resource Areas
1

Authentication & Security 2

GitHub Actions Workflow Runs API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (personalAccessToken). By default, every request must be authenticated.

  • bearerAuth — GitHub personal access token or OAuth token
  • personalAccessToken — Fine-grained personal access token with Actions permissions

Paths & Operations 17

Across 14 paths, the API surfaces 17 operations — 2 DELETE, 8 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Workflow Runs 17

Manage and monitor workflow run executions

GET
/repos/{owner}/{repo}/actions/runs
Github Actions List Workflow Runs for a Repository
listWorkflowRunsForRepo 8 params → 200
GET
/repos/{owner}/{repo}/actions/runs/{run_id}
Github Actions Get a Workflow Run
getWorkflowRun 3 params → 200
DELETE
/repos/{owner}/{repo}/actions/runs/{run_id}
Github Actions Delete a Workflow Run
deleteWorkflowRun 3 params → 204
POST
/repos/{owner}/{repo}/actions/runs/{run_id}/approve
Github Actions Approve a Workflow Run for a Fork Pull Request
approveWorkflowRun 3 params → 201
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/approvals
Github Actions Get the Review History for a Workflow Run
getWorkflowRunApprovals 3 params → 200
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}
Github Actions Get a Workflow Run Attempt
getWorkflowRunAttempt 4 params → 200
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs
Github Actions Download Workflow Run Attempt Logs
downloadWorkflowRunAttemptLogs 4 params → 302
POST
/repos/{owner}/{repo}/actions/runs/{run_id}/cancel
Github Actions Cancel a Workflow Run
cancelWorkflowRun 3 params → 202
POST
/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule
Github Actions Review Custom Deployment Protection Rules for a Workflow Run
reviewCustomGatesForRun 3 params body → 204
POST
/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel
Github Actions Force Cancel a Workflow Run
forceCancelWorkflowRun 3 params → 202
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/logs
Github Actions Download Workflow Run Logs
downloadWorkflowRunLogs 3 params → 302
DELETE
/repos/{owner}/{repo}/actions/runs/{run_id}/logs
Github Actions Delete Workflow Run Logs
deleteWorkflowRunLogs 3 params → 204
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments
Github Actions Get Pending Deployments for a Workflow Run
getPendingDeployments 3 params → 200
POST
/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments
Github Actions Review Pending Deployments for a Workflow Run
reviewPendingDeployments 3 params body → 200
POST
/repos/{owner}/{repo}/actions/runs/{run_id}/rerun
Github Actions Re-run a Workflow
rerunWorkflowRun 3 params body → 201
POST
/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs
Github Actions Re-run Failed Jobs From a Workflow Run
rerunFailedJobs 3 params body → 201
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/timing
Github Actions Get Workflow Run Usage
getWorkflowRunUsage 3 params → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are WorkflowRun (29 properties), MinimalRepository (9 properties), Deployment (8 properties), SimpleUser (7 properties). Each schema is shown below with its type and property counts.

SimpleUser
object
7 properties
WorkflowRunUsage
object
2 properties
EnvironmentApproval
object
4 properties
SimpleCommit
object
6 properties
PendingDeployment
object
5 properties
MinimalRepository
object
9 properties
WorkflowRun
object
29 properties
Deployment
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

github-actions-workflow-runs-api-openapi.yml Raw ↑

Other APIs GitHub Actions publishes across the network.

GitHub Actions Artifacts API
GitHub Actions Cache API
GitHub Actions Jobs API
GitHub Actions OIDC API
GitHub Actions Permissions API
GitHub Actions Secrets API
GitHub Actions Self-Hosted Runner Groups API
GitHub Actions Self-Hosted Runners API
GitHub Actions Variables API
GitHub Actions Workflows API
Where this information came from

This is an independent, third-party profile of GitHub Actions Workflow 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.