workflow_runs
Overview
Name | workflow_runs |
Type | Resource |
Id | github.actions.workflow_runs |
Fields
Name | Datatype | Description |
---|---|---|
id | integer | The ID of the workflow run. |
name | string | The name of the workflow run. |
status | string | |
html_url | string | |
head_commit | object | Simple Commit |
head_branch | string | |
run_started_at | string | The start time of the latest run. Resets on re-run. |
head_sha | string | The SHA of the head commit that points to the version of the worflow being run. |
event | string | |
head_repository_id | integer | |
jobs_url | string | The URL to the jobs for the workflow run. |
run_number | integer | The auto incrementing run number for the workflow run. |
conclusion | string | |
previous_attempt_url | string | The URL to the previous attempted run of this workflow, if one exists. |
node_id | string | |
check_suite_node_id | string | The node ID of the associated check suite. |
head_repository | object | Minimal Repository |
cancel_url | string | The URL to cancel the workflow run. |
workflow_url | string | The URL to the workflow. |
created_at | string | |
workflow_id | integer | The ID of the parent workflow. |
repository | object | Minimal Repository |
check_suite_url | string | The URL to the associated check suite. |
artifacts_url | string | The URL to the artifacts for the workflow run. |
updated_at | string | |
pull_requests | array | |
url | string | The URL to the workflow run. |
logs_url | string | The URL to download the logs for the workflow run. |
rerun_url | string | The URL to rerun the workflow run. |
run_attempt | integer | Attempt number of the run, 1 for first attempt and higher if the workflow was re-run. |
check_suite_id | integer | The ID of the associated check suite. |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get_workflow_run | SELECT | owner, repo, run_id | Gets 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_attempt | SELECT | attempt_number, owner, repo, run_id | Gets 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 touse this endpoint. |
list_workflow_runs | SELECT | owner, repo, workflow_id | List 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_repo | SELECT | owner, repo | Lists 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_run | DELETE | owner, repo, run_id | Delete 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 usethis endpoint. |
cancel_workflow_run | EXEC | owner, repo, run_id | Cancels 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_logs | EXEC | owner, repo, run_id | Deletes 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_logs | EXEC | attempt_number, owner, repo, run_id | Gets 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 tothe 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_logs | EXEC | owner, repo, run_id | Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look forLocation: in the response header to find the URL for the download. Anyone with read access to the repository can usethis endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must havethe actions:read permission to use this endpoint. |
re_run_workflow | EXEC | owner, repo, run_id | Re-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. |