Get a workflow run

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.

返回响应

🟢200Response

application/json

Body

An invocation of a workflow

artifacts_url

string

必需

The URL to the artifacts for the workflow run.

示例值:

https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts

cancel_url

string

必需

The URL to cancel the workflow run.

示例值:

https://api.github.com/repos/github/hello-world/actions/runs/5/cancel

check_suite_id

integer

可选

The ID of the associated check suite.

示例值:

check_suite_node_id

string

可选

The node ID of the associated check suite.

示例值:

MDEwOkNoZWNrU3VpdGU0Mg==

check_suite_url

string

必需

The URL to the associated check suite.

示例值:

https://api.github.com/repos/github/hello-world/check-suites/12

conclusion

string | null

必需

示例值:

neutral

created_at

string <date-time>

必需

event

string

必需

示例值:

push

head_branch

string | null

必需

示例值:

master

head_commit

null | allOf {1}

必需

object (Simple Commit)

可选

Simple Commit

head_repository

object (Minimal Repository)

必需

Minimal Repository

archive_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}

archived

boolean

可选

assignees_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/assignees{/user}

blobs_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}

branches_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/branches{/branch}

clone_url

string

可选

collaborators_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}

comments_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/comments{/number}

commits_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/commits{/sha}

compare_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}

contents_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/contents/{+path}

contributors_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/contributors

created_at

string <date-time> | null

可选

示例值:

2011-01-26T19:01:12Z

default_branch

string

可选

delete_branch_on_merge

boolean

可选

deployments_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/deployments

description

string | null

必需

示例值:

This your first repo!

disabled

boolean

可选

downloads_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/downloads

events_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/events

fork

boolean

必需

forks

integer

可选

示例值:

forks_count

integer

可选

forks_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/forks

full_name

string

必需

示例值:

octocat/Hello-World

git_commits_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}

git_refs_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}

git_tags_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}

git_url

string

可选

has_downloads

boolean

可选

has_issues

boolean

可选

has_pages

boolean

可选

has_projects

boolean

可选

has_wiki

boolean

可选

homepage

string | null

可选

hooks_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/hooks

html_url

string <uri>

必需

示例值:

https://github.com/octocat/Hello-World

integer

必需

示例值:

1296269

is_template

boolean

可选

issue_comment_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}

issue_events_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/issues/events{/number}

issues_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/issues{/number}

keys_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/keys{/key_id}

labels_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/labels{/name}

language

string | null

可选

languages_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/languages

license

object | null

可选

merges_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/merges

milestones_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/milestones{/number}

mirror_url

string | null

可选

name

string

必需

示例值:

Hello-World

network_count

integer

可选

node_id

string

必需

示例值:

MDEwOlJlcG9zaXRvcnkxMjk2MjY5

notifications_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}

open_issues

integer

可选

示例值:

open_issues_count

integer

可选

owner

object | null | allOf {1}

必需

permissions

object

可选

private

boolean

必需

pulls_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/pulls{/number}

pushed_at

string <date-time> | null

可选

示例值:

2011-01-26T19:06:43Z

releases_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/releases{/id}

size

integer

可选

ssh_url

string

可选

stargazers_count

integer

可选

stargazers_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/stargazers

statuses_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/statuses/{sha}

subscribers_count

integer

可选

subscribers_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/subscribers

subscription_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/subscription

svn_url

string

可选

tags_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/tags

teams_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/teams

temp_clone_token

string

可选

template_repository

object | null | allOf {1}

可选

topics

array[string]

可选

trees_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}

updated_at

string <date-time> | null

可选

示例值:

2011-01-26T19:14:43Z

url

string <uri>

必需

示例值:

https://api.github.com/repos/octocat/Hello-World

visibility

string

可选

watchers

integer

可选

示例值:

watchers_count

integer

可选

head_repository_id

integer

可选

示例值:

head_sha

string

必需

The SHA of the head commit that points to the version of the worflow being run.

示例值:

009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d

html_url

string

必需

示例值:

https://github.com/github/hello-world/suites/4

integer

必需

The ID of the workflow run.

示例值:

jobs_url

string

必需

The URL to the jobs for the workflow run.

示例值:

https://api.github.com/repos/github/hello-world/actions/runs/5/jobs

logs_url

string

必需

The URL to download the logs for the workflow run.

示例值:

https://api.github.com/repos/github/hello-world/actions/runs/5/logs

name

string | null

可选

The name of the workflow run.

示例值:

Build

node_id

string

必需

示例值:

MDEwOkNoZWNrU3VpdGU1

pull_requests

array[object (Pull Request Minimal) {5}] | null

必需

base

object

必需

head

object

必需

integer

必需

number

integer

必需

url

string

必需

repository

object (Minimal Repository)

必需

Minimal Repository

rerun_url

string

必需

The URL to rerun the workflow run.

示例值:

https://api.github.com/repos/github/hello-world/actions/runs/5/rerun

run_number

integer

必需

The auto incrementing run number for the workflow run.

示例值:

106

status

string | null

必需

示例值:

completed

updated_at

string <date-time>

必需

url

string

必需

The URL to the workflow run.

示例值:

https://api.github.com/repos/github/hello-world/actions/runs/5

workflow_id

integer

必需

The ID of the parent workflow.

示例值:

workflow_url

string

必需

The URL to the workflow.

示例值:

https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml

请求参数

返回响应