GitHub Actions

GitHub Actions Workflow Runs API

Manage and monitor workflow run executions

GitHub OpenAPI
Business capability
Continuous Integration Management BC-4210.10

Operations 17

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /repos/{owner}/{repo}/actions/runs List workflow runs across a whole repository · Github Actions List Workflow Runs for a Repository #
Ask an LLM
“What workflow runs have happened in my repository recently, across all workflows?”
“Can I filter all of a repo's runs by who triggered them or by event type?”
Tell an agent
List all workflow runs in {owner}/{repo}.
Show repo-wide runs in {owner}/{repo} triggered by {actor} on branch {branch}.
GET /repos/{owner}/{repo}/actions/runs/{run_id} Get the status of one workflow run · Github Actions Get a Workflow Run #
Ask an LLM
“Did a particular workflow run succeed or fail?”
“What commit and branch did a given run build?”
Tell an agent
Get workflow run {run_id} in {owner}/{repo}.
Tell me the status and conclusion of run {run_id}.
DELETE /repos/{owner}/{repo}/actions/runs/{run_id} Delete a workflow run · Github Actions Delete a Workflow Run #
Ask an LLM
“How do I remove an old workflow run from my repository's history?”
“Who is allowed to delete a workflow run?”
Tell an agent destructive · confirm first
Delete workflow run {run_id} from {owner}/{repo}.
Remove run {run_id} from the run history entirely.
POST /repos/{owner}/{repo}/actions/runs/{run_id}/approve Approve a first-time contributor's fork run · Github Actions Approve a Workflow Run for a Fork Pull Request #
Ask an LLM
“How do I let a workflow run from a first-time contributor's fork pull request go ahead?”
“Why is a fork PR's workflow waiting, and can I approve it through the API?”
Tell an agent
Approve the fork pull request run {run_id} in {owner}/{repo}.
Allow the first-time contributor's workflow run {run_id} to start.
GET /repos/{owner}/{repo}/actions/runs/{run_id}/approvals See the deployment review history for a run · Github Actions Get the Review History for a Workflow Run #
Ask an LLM
“Who approved or rejected the deployments in a workflow run, and with what comment?”
“What is the review history for a run that went through environment approvals?”
Tell an agent
Show the review history for run {run_id} in {owner}/{repo}.
List who reviewed the deployments in run {run_id} and what they decided.
GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number} Get one attempt of a re-run workflow · Github Actions Get a Workflow Run Attempt #
Ask an LLM
“What was the outcome of the first attempt before I re-ran a workflow?”
“Can I look at a specific retry attempt of a run?”
Tell an agent
Get attempt {attempt_number} of run {run_id} in {owner}/{repo}.
Show the conclusion of attempt {attempt_number} of workflow run {run_id}.
GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs Download logs for one attempt of a run · Github Actions Download Workflow Run Attempt Logs #
Ask an LLM
“How do I download the logs from an earlier attempt of a run I have since re-run?”
“Can I get the log archive for just one retry attempt?”
Tell an agent
Download the logs for attempt {attempt_number} of run {run_id} in {owner}/{repo}.
Fetch the log archive of retry attempt {attempt_number} of run {run_id}.
POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel Cancel a workflow run · Github Actions Cancel a Workflow Run #
Ask an LLM
“How do I stop a workflow run that is in progress?”
“Can I cancel a queued run before it starts?”
Tell an agent destructive · confirm first
Cancel workflow run {run_id} in {owner}/{repo}.
Stop the in-progress run {run_id}.
POST /repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule Approve or reject a custom deployment protection rule · Github Actions Review Custom Deployment Protection Rules for a Workflow Run #
Ask an LLM
“How does a custom deployment protection rule app approve a waiting run?”
“Can I reject a custom protection gate for an environment and leave a comment?”
Tell an agent
Set the custom protection rule for environment {environment_name} on run {run_id} in {owner}/{repo} to {state}.
Reject the custom deployment gate for {environment_name} on run {run_id} with comment {comment}.
POST /repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel Force cancel a stuck workflow run · Github Actions Force Cancel a Workflow Run #
Ask an LLM
“What can I do when a workflow run ignores a normal cancel request?”
“Is there a way to force-stop a hung run?”
Tell an agent destructive · confirm first
Force cancel run {run_id} in {owner}/{repo}.
Force-stop the unresponsive run {run_id} that will not cancel normally.
GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs Download all logs for a workflow run · Github Actions Download Workflow Run Logs #
Ask an LLM
“How do I download the complete log archive of a workflow run?”
“How long does the run log download link stay valid?”
Tell an agent
Download the full log archive for run {run_id} in {owner}/{repo}.
Get me the zipped logs of every job in run {run_id}.
DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs Delete the logs of a workflow run · Github Actions Delete Workflow Run Logs #
Ask an LLM
“How do I wipe the logs of a run that accidentally printed a secret?”
“Can I delete a run's logs but keep the run record?”
Tell an agent destructive · confirm first
Delete all logs for run {run_id} in {owner}/{repo}.
Purge the log output of run {run_id}.
GET /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments List deployments waiting on protection rules · Github Actions Get Pending Deployments for a Workflow Run #
Ask an LLM
“Which environments is a workflow run waiting on before it can deploy?”
“Is my run stuck waiting for a required reviewer, and who can approve it?”
Tell an agent
Show the pending deployments for run {run_id} in {owner}/{repo}.
List the environments run {run_id} is waiting to deploy to.
POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments Approve or reject deployments awaiting a reviewer · Github Actions Review Pending Deployments for a Workflow Run #
Ask an LLM
“How do I approve a deployment that is waiting for me as a required reviewer?”
“Can I reject a pending deployment to several environments at once?”
Tell an agent
Mark pending deployments to environments {environment_ids} on run {run_id} in {owner}/{repo} as {state} with comment {comment}.
As required reviewer, approve the waiting deployment to {environment_ids} for run {run_id}: {comment}.
POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun Re-run an entire workflow run · Github Actions Re-run a Workflow #
Ask an LLM
“How do I re-run every job in a workflow run?”
“Can I re-run a whole workflow with debug logging turned on?”
Tell an agent
Re-run the whole of workflow run {run_id} in {owner}/{repo}.
Re-run all jobs of run {run_id} with debug logging {enable_debug_logging}.
POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs Re-run only the failed jobs of a run · Github Actions Re-run Failed Jobs From a Workflow Run #
Ask an LLM
“Can I retry just the jobs that failed in a run and skip the ones that passed?”
“How do I re-run failed jobs along with the jobs that depend on them?”
Tell an agent
Re-run the failed jobs in run {run_id} of {owner}/{repo}.
Retry only what failed in run {run_id}, with debug logging {enable_debug_logging}.
GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing Check billable minutes and run time for a run · Github Actions Get Workflow Run Usage #
Ask an LLM
“How many billable minutes did a single workflow run consume?”
“How long did one run take in total?”
Tell an agent
Get the billable minutes and run duration of run {run_id} in {owner}/{repo}.
Show how much time run {run_id} was billed for.

Documentation

📖
Documentation
https://docs.github.com/en/rest/actions
📖
Authentication
https://docs.github.com/en/rest/overview/authenticating-to-the-rest-api
📖
GettingStarted
https://docs.github.com/en/actions/get-started/quickstart
📖
APIReference
https://docs.github.com/en/rest/actions
📖
RateLimits
https://docs.github.com/en/rest/overview/rate-limits-for-the-rest-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/github-actions/refs/heads/main/openapi/github-actions-workflow-runs-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/github-actions/refs/heads/main/json-schema/github-actions-workflow-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/github-actions/refs/heads/main/json-schema/github-actions-run-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/github-actions/refs/heads/main/json-schema/github-actions-job-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/github-actions/refs/heads/main/json-schema/github-actions-artifact-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/github-actions/refs/heads/main/json-schema/github-actions-secret-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/github-actions/refs/heads/main/json-schema/github-actions-runner-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/github-actions/refs/heads/main/json-schema/github-actions-variable-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/github-actions/refs/heads/main/json-schema/github-actions-cache-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/github-actions/refs/heads/main/json-schema/github-actions-simple-user-schema.json

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/github-actions/refs/heads/main/overlays/github-actions-workflow-runs-api-overlay.yaml
🔗
ChangeLog
https://github.blog/changelog/label/actions/
🔗
SDKs
https://github.com/octokit/octokit.js
🔗
SDKs
https://github.com/octokit/octokit.rb
🔗
SDKs
https://github.com/octokit/octokit.net
🔗
SDKs
https://github.com/google/go-github
🔗
CLI
https://cli.github.com/manual/gh_workflow_run
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/github-actions/refs/heads/main/json-ld/github-actions-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/github-actions:github-actions-workflow-runs-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

github-actions-workflow-runs-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: GitHub Actions Workflow Runs API
  description: REST API for managing GitHub Actions workflows, runs, artifacts, secrets, runners, caches, variables, permissions, and OIDC.
  version: 1.0.0
  contact:
    name: GitHub Support
    url: https://support.github.com
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
- url: https://api.github.com
  description: GitHub REST API
security:
- bearerAuth: []
- personalAccessToken: []
tags:


# --- truncated at 32 KB (36 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/github-actions/refs/heads/main/openapi/github-actions-workflow-runs-api-openapi.yml