Sample - GitHub REST API
GET/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}

Get a workflow run attempt

Gets a specific workflow run attempt.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

5 parameters
ownerstringrequired
The account owner of the repository. The name is not case sensitive.
repostringrequired
The name of the repository without the `.git` extension. The name is not case sensitive.
run_idintegerrequired
The unique identifier of the workflow run.
attempt_numberintegerrequired
The attempt number of the workflow run.
exclude_pull_requestsbooleanoptional
If `true` pull requests are omitted from the response (empty array).
Default:false

1 status code
200Response
idintegerrequired
The ID of the workflow run.
namestringoptional
The name of the workflow run.
node_idstringrequired
check_suite_idintegeroptional
The ID of the associated check suite.
check_suite_node_idstringoptional
The node ID of the associated check suite.
head_branchstringrequired
head_shastringrequired
The SHA of the head commit that points to the version of the workflow being run.
pathstringrequired
The full path of the workflow
run_numberintegerrequired
The auto incrementing run number for the workflow run.
run_attemptintegeroptional
Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.
referenced_workflowsarray<ReferencedWorkflow>optional
eventstringrequired
statusstringrequired
conclusionstringrequired
workflow_idintegerrequired
The ID of the parent workflow.
urlstringrequired
The URL to the workflow run.
html_urlstringrequired
pull_requestsarray<PullRequestMinimal>required
Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run.
created_atstringrequired
updated_atstringrequired
actorobjectoptional
A GitHub user.
triggering_actorobjectoptional
A GitHub user.
run_started_atstringoptional
The start time of the latest run. Resets on re-run.
jobs_urlstringrequired
The URL to the jobs for the workflow run.
logs_urlstringrequired
The URL to download the logs for the workflow run.
check_suite_urlstringrequired
The URL to the associated check suite.
artifacts_urlstringrequired
The URL to the artifacts for the workflow run.
cancel_urlstringrequired
The URL to cancel the workflow run.
rerun_urlstringrequired
The URL to rerun the workflow run.
previous_attempt_urlstringoptional
The URL to the previous attempted run of this workflow, if one exists.
workflow_urlstringrequired
The URL to the workflow.
head_commitobjectrequired
A commit.
repositoryobjectrequired
Minimal Repository
head_repositoryobjectrequired
Minimal Repository
head_repository_idintegeroptional
display_titlestringrequired
The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow.