Skip to main content

workflow_runs

Overview

Nameworkflow_runs
TypeResource
Idgithub.actions.workflow_runs

Fields

NameDatatypeDescription
idintegerThe ID of the workflow run.
namestringThe name of the workflow run.
statusstring
html_urlstring
head_commitobjectSimple Commit
head_branchstring
run_started_atstringThe start time of the latest run. Resets on re-run.
head_shastringThe SHA of the head commit that points to the version of the worflow being run.
eventstring
head_repository_idinteger
jobs_urlstringThe URL to the jobs for the workflow run.
run_numberintegerThe auto incrementing run number for the workflow run.
conclusionstring
previous_attempt_urlstringThe URL to the previous attempted run of this workflow, if one exists.
node_idstring
check_suite_node_idstringThe node ID of the associated check suite.
head_repositoryobjectMinimal Repository
cancel_urlstringThe URL to cancel the workflow run.
workflow_urlstringThe URL to the workflow.
created_atstring
workflow_idintegerThe ID of the parent workflow.
repositoryobjectMinimal Repository
check_suite_urlstringThe URL to the associated check suite.
artifacts_urlstringThe URL to the artifacts for the workflow run.
updated_atstring
pull_requestsarray
urlstringThe URL to the workflow run.
logs_urlstringThe URL to download the logs for the workflow run.
rerun_urlstringThe URL to rerun the workflow run.
run_attemptintegerAttempt number of the run, 1 for first attempt and higher if the workflow was re-run.
check_suite_idintegerThe ID of the associated check suite.

Methods

NameAccessible byRequired ParamsDescription
get_workflow_runSELECTowner, repo, run_idGets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
get_workflow_run_attemptSELECTattempt_number, owner, repo, run_idGets a specific workflow run attempt. Anyone with read access to the repository
can use this endpoint. If the repository is private you must use an access token
with the repo scope. GitHub Apps must have the actions:read permission to
use this endpoint.
list_workflow_runsSELECTowner, repo, workflow_idList all workflow runs for a workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope.
list_workflow_runs_for_repoSELECTowner, repoLists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
delete_workflow_runDELETEowner, repo, run_idDelete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is
private you must use an access token with the repo scope. GitHub Apps must have the actions:write permission to use
this endpoint.
cancel_workflow_runEXECowner, repo, run_idCancels a workflow run using its id. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
delete_workflow_run_logsEXECowner, repo, run_idDeletes all logs for a workflow run. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
download_workflow_run_attempt_logsEXECattempt_number, owner, repo, run_idGets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after
1 minute. Look for Location: in the response header to find the URL for the download. Anyone with read access to
the repository can use this endpoint. If the repository is private you must use an access token with the repo scope.
GitHub Apps must have the actions:read permission to use this endpoint.
download_workflow_run_logsEXECowner, repo, run_idGets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for
Location: in the response header to find the URL for the download. Anyone with read access to the repository can use
this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have
the actions:read permission to use this endpoint.
re_run_workflowEXECowner, repo, run_idRe-runs your workflow run using its id. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.