Execução de fluxo de trabalho
Use a API REST para interagir com execuções de fluxo de trabalho no GitHub Actions.
Sobre as execuções de fluxo de trabalho no GitHub Actions
Use a API REST para exibir, executar novamente e cancelar logs de execuções de fluxo de trabalho no GitHub Actions. A execução de um fluxo de trabalho é uma instância do seu fluxo de trabalho que é executado quando ocorre um evento pré-configurado. Para obter mais informações, confira "Gerenciar fluxos de trabalho".
Esses pontos de extremidade estão disponíveis para usuários autenticados, OAuth Apps e GitHub Apps. Os tokens de acesso exigem o escopo repo
para repositórios privados e o escopo public_repo
para repositórios públicos. Os GitHub Apps precisam ter a permissão actions
para usar esses pontos de extremidade.
Re-run a job from a workflow run
Re-run a job and its dependent jobs in 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.
Parâmetros para "Re-run a job from a workflow run"
Cabeçalhos |
---|
Name, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Name, Tipo, Descrição |
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository. The name is not case sensitive. |
job_id integer ObrigatórioThe unique identifier of the job. |
Parâmetros do corpo |
Name, Tipo, Descrição |
enable_debug_logging boolean Whether to enable debug logging for the re-run. Padrão: |
Códigos de status de resposta HTTP para "Re-run a job from a workflow run"
Código de status | Descrição |
---|---|
201 | Created |
403 | Forbidden |
Exemplos de código para "Re-run a job from a workflow run"
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/jobs/JOB_ID/rerun
Response
Status: 201
List workflow runs for a repository
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.
Parâmetros para "List workflow runs for a repository"
Cabeçalhos |
---|
Name, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Name, Tipo, Descrição |
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository. The name is not case sensitive. |
Parâmetros de consulta |
Name, Tipo, Descrição |
actor string Returns someone's workflow runs. Use the login for the user who created the |
branch string Returns workflow runs associated with a branch. Use the name of the branch of the |
event string Returns workflow run triggered by the event you specify. For example, |
status string Returns workflow runs with the check run Pode ser um dos: |
per_page integer The number of results per page (max 100). Padrão: |
page integer Page number of the results to fetch. Padrão: |
created string Returns workflow runs created within the given date-time range. For more information on the syntax, see "Understanding the search syntax." |
exclude_pull_requests boolean If Padrão: |
check_suite_id integer Returns workflow runs with the |
head_sha string Only returns workflow runs that are associated with the specified |
Códigos de status de resposta HTTP para "List workflow runs for a repository"
Código de status | Descrição |
---|---|
200 | OK |
Exemplos de código para "List workflow runs for a repository"
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/runs
Response
Status: 200
{
"total_count": 1,
"workflow_runs": [
{
"id": 30433642,
"name": "Build",
"node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==",
"check_suite_id": 42,
"check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==",
"head_branch": "master",
"head_sha": "acb5820ced9479c074f688cc328bf03f341a511d",
"run_number": 562,
"event": "push",
"status": "queued",
"conclusion": null,
"workflow_id": 159038,
"url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/runs/30433642",
"html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642",
"pull_requests": [],
"created_at": "2020-01-22T19:33:08Z",
"updated_at": "2020-01-22T19:33:08Z",
"actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"run_attempt": 1,
"run_started_at": "2020-01-22T19:33:08Z",
"triggering_actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"jobs_url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/runs/30433642/jobs",
"logs_url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/runs/30433642/logs",
"check_suite_url": "https://HOSTNAME/repos/octo-org/octo-repo/check-suites/414944374",
"artifacts_url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/runs/30433642/artifacts",
"cancel_url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/runs/30433642/cancel",
"rerun_url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/runs/30433642/rerun",
"workflow_url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/workflows/159038",
"head_commit": {
"id": "acb5820ced9479c074f688cc328bf03f341a511d",
"tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223",
"message": "Create linter.yaml",
"timestamp": "2020-01-22T19:33:05Z",
"author": {
"name": "Octo Cat",
"email": "octocat@github.com"
},
"committer": {
"name": "GitHub",
"email": "noreply@github.com"
}
},
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"private": false,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": false,
"url": "https://HOSTNAME/repos/octocat/Hello-World",
"archive_url": "https://HOSTNAME/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://HOSTNAME/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://HOSTNAME/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://HOSTNAME/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://HOSTNAME/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://HOSTNAME/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://HOSTNAME/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://HOSTNAME/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://HOSTNAME/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://HOSTNAME/repos/octocat/Hello-World/contributors",
"deployments_url": "https://HOSTNAME/repos/octocat/Hello-World/deployments",
"downloads_url": "https://HOSTNAME/repos/octocat/Hello-World/downloads",
"events_url": "https://HOSTNAME/repos/octocat/Hello-World/events",
"forks_url": "https://HOSTNAME/repos/octocat/Hello-World/forks",
"git_commits_url": "https://HOSTNAME/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://HOSTNAME/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://HOSTNAME/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://HOSTNAME/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://HOSTNAME/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://HOSTNAME/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://HOSTNAME/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://HOSTNAME/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://HOSTNAME/repos/octocat/Hello-World/languages",
"merges_url": "https://HOSTNAME/repos/octocat/Hello-World/merges",
"milestones_url": "https://HOSTNAME/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://HOSTNAME/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://HOSTNAME/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://HOSTNAME/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://HOSTNAME/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://HOSTNAME/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://HOSTNAME/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://HOSTNAME/repos/octocat/Hello-World/subscription",
"tags_url": "https://HOSTNAME/repos/octocat/Hello-World/tags",
"teams_url": "https://HOSTNAME/repos/octocat/Hello-World/teams",
"trees_url": "https://HOSTNAME/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "http://HOSTNAME/repos/octocat/Hello-World/hooks"
},
"head_repository": {
"id": 217723378,
"node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
"name": "octo-repo",
"full_name": "octo-org/octo-repo",
"private": true,
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"html_url": "https://github.com/octo-org/octo-repo",
"description": null,
"fork": false,
"url": "https://HOSTNAME/repos/octo-org/octo-repo",
"forks_url": "https://HOSTNAME/repos/octo-org/octo-repo/forks",
"keys_url": "https://HOSTNAME/repos/octo-org/octo-repo/keys{/key_id}",
"collaborators_url": "https://HOSTNAME/repos/octo-org/octo-repo/collaborators{/collaborator}",
"teams_url": "https://HOSTNAME/repos/octo-org/octo-repo/teams",
"hooks_url": "https://HOSTNAME/repos/octo-org/octo-repo/hooks",
"issue_events_url": "https://HOSTNAME/repos/octo-org/octo-repo/issues/events{/number}",
"events_url": "https://HOSTNAME/repos/octo-org/octo-repo/events",
"assignees_url": "https://HOSTNAME/repos/octo-org/octo-repo/assignees{/user}",
"branches_url": "https://HOSTNAME/repos/octo-org/octo-repo/branches{/branch}",
"tags_url": "https://HOSTNAME/repos/octo-org/octo-repo/tags",
"blobs_url": "https://HOSTNAME/repos/octo-org/octo-repo/git/blobs{/sha}",
"git_tags_url": "https://HOSTNAME/repos/octo-org/octo-repo/git/tags{/sha}",
"git_refs_url": "https://HOSTNAME/repos/octo-org/octo-repo/git/refs{/sha}",
"trees_url": "https://HOSTNAME/repos/octo-org/octo-repo/git/trees{/sha}",
"statuses_url": "https://HOSTNAME/repos/octo-org/octo-repo/statuses/{sha}",
"languages_url": "https://HOSTNAME/repos/octo-org/octo-repo/languages",
"stargazers_url": "https://HOSTNAME/repos/octo-org/octo-repo/stargazers",
"contributors_url": "https://HOSTNAME/repos/octo-org/octo-repo/contributors",
"subscribers_url": "https://HOSTNAME/repos/octo-org/octo-repo/subscribers",
"subscription_url": "https://HOSTNAME/repos/octo-org/octo-repo/subscription",
"commits_url": "https://HOSTNAME/repos/octo-org/octo-repo/commits{/sha}",
"git_commits_url": "https://HOSTNAME/repos/octo-org/octo-repo/git/commits{/sha}",
"comments_url": "https://HOSTNAME/repos/octo-org/octo-repo/comments{/number}",
"issue_comment_url": "https://HOSTNAME/repos/octo-org/octo-repo/issues/comments{/number}",
"contents_url": "https://HOSTNAME/repos/octo-org/octo-repo/contents/{+path}",
"compare_url": "https://HOSTNAME/repos/octo-org/octo-repo/compare/{base}...{head}",
"merges_url": "https://HOSTNAME/repos/octo-org/octo-repo/merges",
"archive_url": "https://HOSTNAME/repos/octo-org/octo-repo/{archive_format}{/ref}",
"downloads_url": "https://HOSTNAME/repos/octo-org/octo-repo/downloads",
"issues_url": "https://HOSTNAME/repos/octo-org/octo-repo/issues{/number}",
"pulls_url": "https://HOSTNAME/repos/octo-org/octo-repo/pulls{/number}",
"milestones_url": "https://HOSTNAME/repos/octo-org/octo-repo/milestones{/number}",
"notifications_url": "https://HOSTNAME/repos/octo-org/octo-repo/notifications{?since,all,participating}",
"labels_url": "https://HOSTNAME/repos/octo-org/octo-repo/labels{/name}",
"releases_url": "https://HOSTNAME/repos/octo-org/octo-repo/releases{/id}",
"deployments_url": "https://HOSTNAME/repos/octo-org/octo-repo/deployments"
}
}
]
}
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.
Parâmetros para "Get a workflow run"
Cabeçalhos |
---|
Name, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Name, Tipo, Descrição |
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository. The name is not case sensitive. |
run_id integer ObrigatórioThe unique identifier of the workflow run. |
Parâmetros de consulta |
Name, Tipo, Descrição |
exclude_pull_requests boolean If Padrão: |
Códigos de status de resposta HTTP para "Get a workflow run"
Código de status | Descrição |
---|---|
200 | OK |
Exemplos de código para "Get a workflow run"
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/runs/RUN_ID
Response
Status: 200
{
"id": 30433642,
"name": "Build",
"node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==",
"check_suite_id": 42,
"check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==",
"head_branch": "main",
"head_sha": "acb5820ced9479c074f688cc328bf03f341a511d",
"path": ".github/workflows/build.yml@main",
"run_number": 562,
"event": "push",
"status": "queued",
"workflow_id": 159038,
"url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/runs/30433642",
"html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642",
"pull_requests": [],
"created_at": "2020-01-22T19:33:08Z",
"updated_at": "2020-01-22T19:33:08Z",
"actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"run_attempt": 1,
"referenced_workflows": [
{
"path": "octocat/Hello-World/.github/workflows/deploy.yml@main",
"sha": "86e8bc9ecf7d38b1ed2d2cfb8eb87ba9b35b01db",
"ref": "refs/heads/main"
},
{
"path": "octo-org/octo-repo/.github/workflows/report.yml@v2",
"sha": "79e9790903e1c3373b1a3e3a941d57405478a232",
"ref": "refs/tags/v2"
},
{
"path": "octo-org/octo-repo/.github/workflows/secure.yml@1595d4b6de6a9e9751fb270a41019ce507d4099e",
"sha": "1595d4b6de6a9e9751fb270a41019ce507d4099e"
}
],
"run_started_at": "2020-01-22T19:33:08Z",
"triggering_actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"jobs_url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/runs/30433642/jobs",
"logs_url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/runs/30433642/logs",
"check_suite_url": "https://HOSTNAME/repos/octo-org/octo-repo/check-suites/414944374",
"artifacts_url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/runs/30433642/artifacts",
"cancel_url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/runs/30433642/cancel",
"rerun_url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/runs/30433642/rerun",
"previous_attempt_url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/runs/30433642/attempts/1",
"workflow_url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/workflows/159038",
"head_commit": {
"id": "acb5820ced9479c074f688cc328bf03f341a511d",
"tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223",
"message": "Create linter.yaml",
"timestamp": "2020-01-22T19:33:05Z",
"author": {
"name": "Octo Cat",
"email": "octocat@github.com"
},
"committer": {
"name": "GitHub",
"email": "noreply@github.com"
}
},
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"private": false,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": false,
"url": "https://HOSTNAME/repos/octocat/Hello-World",
"archive_url": "https://HOSTNAME/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://HOSTNAME/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://HOSTNAME/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://HOSTNAME/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://HOSTNAME/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://HOSTNAME/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://HOSTNAME/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://HOSTNAME/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://HOSTNAME/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://HOSTNAME/repos/octocat/Hello-World/contributors",
"deployments_url": "https://HOSTNAME/repos/octocat/Hello-World/deployments",
"downloads_url": "https://HOSTNAME/repos/octocat/Hello-World/downloads",
"events_url": "https://HOSTNAME/repos/octocat/Hello-World/events",
"forks_url": "https://HOSTNAME/repos/octocat/Hello-World/forks",
"git_commits_url": "https://HOSTNAME/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://HOSTNAME/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://HOSTNAME/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://HOSTNAME/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://HOSTNAME/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://HOSTNAME/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://HOSTNAME/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://HOSTNAME/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://HOSTNAME/repos/octocat/Hello-World/languages",
"merges_url": "https://HOSTNAME/repos/octocat/Hello-World/merges",
"milestones_url": "https://HOSTNAME/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://HOSTNAME/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://HOSTNAME/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://HOSTNAME/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://HOSTNAME/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://HOSTNAME/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://HOSTNAME/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://HOSTNAME/repos/octocat/Hello-World/subscription",
"tags_url": "https://HOSTNAME/repos/octocat/Hello-World/tags",
"teams_url": "https://HOSTNAME/repos/octocat/Hello-World/teams",
"trees_url": "https://HOSTNAME/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "http://HOSTNAME/repos/octocat/Hello-World/hooks"
},
"head_repository": {
"id": 217723378,
"node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
"name": "octo-repo",
"full_name": "octo-org/octo-repo",
"private": true,
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"html_url": "https://github.com/octo-org/octo-repo",
"description": null,
"fork": false,
"url": "https://HOSTNAME/repos/octo-org/octo-repo",
"forks_url": "https://HOSTNAME/repos/octo-org/octo-repo/forks",
"keys_url": "https://HOSTNAME/repos/octo-org/octo-repo/keys{/key_id}",
"collaborators_url": "https://HOSTNAME/repos/octo-org/octo-repo/collaborators{/collaborator}",
"teams_url": "https://HOSTNAME/repos/octo-org/octo-repo/teams",
"hooks_url": "https://HOSTNAME/repos/octo-org/octo-repo/hooks",
"issue_events_url": "https://HOSTNAME/repos/octo-org/octo-repo/issues/events{/number}",
"events_url": "https://HOSTNAME/repos/octo-org/octo-repo/events",
"assignees_url": "https://HOSTNAME/repos/octo-org/octo-repo/assignees{/user}",
"branches_url": "https://HOSTNAME/repos/octo-org/octo-repo/branches{/branch}",
"tags_url": "https://HOSTNAME/repos/octo-org/octo-repo/tags",
"blobs_url": "https://HOSTNAME/repos/octo-org/octo-repo/git/blobs{/sha}",
"git_tags_url": "https://HOSTNAME/repos/octo-org/octo-repo/git/tags{/sha}",
"git_refs_url": "https://HOSTNAME/repos/octo-org/octo-repo/git/refs{/sha}",
"trees_url": "https://HOSTNAME/repos/octo-org/octo-repo/git/trees{/sha}",
"statuses_url": "https://HOSTNAME/repos/octo-org/octo-repo/statuses/{sha}",
"languages_url": "https://HOSTNAME/repos/octo-org/octo-repo/languages",
"stargazers_url": "https://HOSTNAME/repos/octo-org/octo-repo/stargazers",
"contributors_url": "https://HOSTNAME/repos/octo-org/octo-repo/contributors",
"subscribers_url": "https://HOSTNAME/repos/octo-org/octo-repo/subscribers",
"subscription_url": "https://HOSTNAME/repos/octo-org/octo-repo/subscription",
"commits_url": "https://HOSTNAME/repos/octo-org/octo-repo/commits{/sha}",
"git_commits_url": "https://HOSTNAME/repos/octo-org/octo-repo/git/commits{/sha}",
"comments_url": "https://HOSTNAME/repos/octo-org/octo-repo/comments{/number}",
"issue_comment_url": "https://HOSTNAME/repos/octo-org/octo-repo/issues/comments{/number}",
"contents_url": "https://HOSTNAME/repos/octo-org/octo-repo/contents/{+path}",
"compare_url": "https://HOSTNAME/repos/octo-org/octo-repo/compare/{base}...{head}",
"merges_url": "https://HOSTNAME/repos/octo-org/octo-repo/merges",
"archive_url": "https://HOSTNAME/repos/octo-org/octo-repo/{archive_format}{/ref}",
"downloads_url": "https://HOSTNAME/repos/octo-org/octo-repo/downloads",
"issues_url": "https://HOSTNAME/repos/octo-org/octo-repo/issues{/number}",
"pulls_url": "https://HOSTNAME/repos/octo-org/octo-repo/pulls{/number}",
"milestones_url": "https://HOSTNAME/repos/octo-org/octo-repo/milestones{/number}",
"notifications_url": "https://HOSTNAME/repos/octo-org/octo-repo/notifications{?since,all,participating}",
"labels_url": "https://HOSTNAME/repos/octo-org/octo-repo/labels{/name}",
"releases_url": "https://HOSTNAME/repos/octo-org/octo-repo/releases{/id}",
"deployments_url": "https://HOSTNAME/repos/octo-org/octo-repo/deployments"
}
}
Delete a workflow run
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 use
this endpoint.
Parâmetros para "Delete a workflow run"
Cabeçalhos |
---|
Name, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Name, Tipo, Descrição |
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository. The name is not case sensitive. |
run_id integer ObrigatórioThe unique identifier of the workflow run. |
Códigos de status de resposta HTTP para "Delete a workflow run"
Código de status | Descrição |
---|---|
204 | No Content |
Exemplos de código para "Delete a workflow run"
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/runs/RUN_ID
Response
Status: 204
Get the review history for a 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.
Parâmetros para "Get the review history for a workflow run"
Cabeçalhos |
---|
Name, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Name, Tipo, Descrição |
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository. The name is not case sensitive. |
run_id integer ObrigatórioThe unique identifier of the workflow run. |
Códigos de status de resposta HTTP para "Get the review history for a workflow run"
Código de status | Descrição |
---|---|
200 | OK |
Exemplos de código para "Get the review history for a workflow run"
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/runs/RUN_ID/approvals
Response
Status: 200
[
{
"state": "approved",
"comment": "Ship it!",
"environments": [
{
"id": 161088068,
"node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4",
"name": "staging",
"url": "https://HOSTNAME/repos/github/hello-world/environments/staging",
"html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging",
"created_at": "2020-11-23T22:00:40Z",
"updated_at": "2020-11-23T22:00:40Z"
}
],
"user": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
}
}
]
Get a workflow run attempt
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 to
use this endpoint.
Parâmetros para "Get a workflow run attempt"
Cabeçalhos |
---|
Name, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Name, Tipo, Descrição |
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository. The name is not case sensitive. |
run_id integer ObrigatórioThe unique identifier of the workflow run. |
attempt_number integer ObrigatórioThe attempt number of the workflow run. |
Parâmetros de consulta |
Name, Tipo, Descrição |
exclude_pull_requests boolean If Padrão: |
Códigos de status de resposta HTTP para "Get a workflow run attempt"
Código de status | Descrição |
---|---|
200 | OK |
Exemplos de código para "Get a workflow run attempt"
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/runs/RUN_ID/attempts/ATTEMPT_NUMBER
Response
Status: 200
{
"id": 30433642,
"name": "Build",
"node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==",
"check_suite_id": 42,
"check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==",
"head_branch": "main",
"head_sha": "acb5820ced9479c074f688cc328bf03f341a511d",
"path": ".github/workflows/build.yml@main",
"run_number": 562,
"event": "push",
"status": "queued",
"workflow_id": 159038,
"url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/runs/30433642",
"html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642",
"pull_requests": [],
"created_at": "2020-01-22T19:33:08Z",
"updated_at": "2020-01-22T19:33:08Z",
"actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"run_attempt": 1,
"referenced_workflows": [
{
"path": "octocat/Hello-World/.github/workflows/deploy.yml@main",
"sha": "86e8bc9ecf7d38b1ed2d2cfb8eb87ba9b35b01db",
"ref": "refs/heads/main"
},
{
"path": "octo-org/octo-repo/.github/workflows/report.yml@v2",
"sha": "79e9790903e1c3373b1a3e3a941d57405478a232",
"ref": "refs/tags/v2"
},
{
"path": "octo-org/octo-repo/.github/workflows/secure.yml@1595d4b6de6a9e9751fb270a41019ce507d4099e",
"sha": "1595d4b6de6a9e9751fb270a41019ce507d4099e"
}
],
"run_started_at": "2020-01-22T19:33:08Z",
"triggering_actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"jobs_url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/runs/30433642/jobs",
"logs_url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/runs/30433642/logs",
"check_suite_url": "https://HOSTNAME/repos/octo-org/octo-repo/check-suites/414944374",
"artifacts_url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/runs/30433642/artifacts",
"cancel_url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/runs/30433642/cancel",
"rerun_url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/runs/30433642/rerun",
"previous_attempt_url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/runs/30433642/attempts/1",
"workflow_url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/workflows/159038",
"head_commit": {
"id": "acb5820ced9479c074f688cc328bf03f341a511d",
"tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223",
"message": "Create linter.yaml",
"timestamp": "2020-01-22T19:33:05Z",
"author": {
"name": "Octo Cat",
"email": "octocat@github.com"
},
"committer": {
"name": "GitHub",
"email": "noreply@github.com"
}
},
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"private": false,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": false,
"url": "https://HOSTNAME/repos/octocat/Hello-World",
"archive_url": "https://HOSTNAME/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://HOSTNAME/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://HOSTNAME/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://HOSTNAME/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://HOSTNAME/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://HOSTNAME/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://HOSTNAME/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://HOSTNAME/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://HOSTNAME/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://HOSTNAME/repos/octocat/Hello-World/contributors",
"deployments_url": "https://HOSTNAME/repos/octocat/Hello-World/deployments",
"downloads_url": "https://HOSTNAME/repos/octocat/Hello-World/downloads",
"events_url": "https://HOSTNAME/repos/octocat/Hello-World/events",
"forks_url": "https://HOSTNAME/repos/octocat/Hello-World/forks",
"git_commits_url": "https://HOSTNAME/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://HOSTNAME/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://HOSTNAME/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://HOSTNAME/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://HOSTNAME/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://HOSTNAME/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://HOSTNAME/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://HOSTNAME/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://HOSTNAME/repos/octocat/Hello-World/languages",
"merges_url": "https://HOSTNAME/repos/octocat/Hello-World/merges",
"milestones_url": "https://HOSTNAME/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://HOSTNAME/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://HOSTNAME/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://HOSTNAME/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://HOSTNAME/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://HOSTNAME/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://HOSTNAME/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://HOSTNAME/repos/octocat/Hello-World/subscription",
"tags_url": "https://HOSTNAME/repos/octocat/Hello-World/tags",
"teams_url": "https://HOSTNAME/repos/octocat/Hello-World/teams",
"trees_url": "https://HOSTNAME/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "http://HOSTNAME/repos/octocat/Hello-World/hooks"
},
"head_repository": {
"id": 217723378,
"node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
"name": "octo-repo",
"full_name": "octo-org/octo-repo",
"private": true,
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"html_url": "https://github.com/octo-org/octo-repo",
"description": null,
"fork": false,
"url": "https://HOSTNAME/repos/octo-org/octo-repo",
"forks_url": "https://HOSTNAME/repos/octo-org/octo-repo/forks",
"keys_url": "https://HOSTNAME/repos/octo-org/octo-repo/keys{/key_id}",
"collaborators_url": "https://HOSTNAME/repos/octo-org/octo-repo/collaborators{/collaborator}",
"teams_url": "https://HOSTNAME/repos/octo-org/octo-repo/teams",
"hooks_url": "https://HOSTNAME/repos/octo-org/octo-repo/hooks",
"issue_events_url": "https://HOSTNAME/repos/octo-org/octo-repo/issues/events{/number}",
"events_url": "https://HOSTNAME/repos/octo-org/octo-repo/events",
"assignees_url": "https://HOSTNAME/repos/octo-org/octo-repo/assignees{/user}",
"branches_url": "https://HOSTNAME/repos/octo-org/octo-repo/branches{/branch}",
"tags_url": "https://HOSTNAME/repos/octo-org/octo-repo/tags",
"blobs_url": "https://HOSTNAME/repos/octo-org/octo-repo/git/blobs{/sha}",
"git_tags_url": "https://HOSTNAME/repos/octo-org/octo-repo/git/tags{/sha}",
"git_refs_url": "https://HOSTNAME/repos/octo-org/octo-repo/git/refs{/sha}",
"trees_url": "https://HOSTNAME/repos/octo-org/octo-repo/git/trees{/sha}",
"statuses_url": "https://HOSTNAME/repos/octo-org/octo-repo/statuses/{sha}",
"languages_url": "https://HOSTNAME/repos/octo-org/octo-repo/languages",
"stargazers_url": "https://HOSTNAME/repos/octo-org/octo-repo/stargazers",
"contributors_url": "https://HOSTNAME/repos/octo-org/octo-repo/contributors",
"subscribers_url": "https://HOSTNAME/repos/octo-org/octo-repo/subscribers",
"subscription_url": "https://HOSTNAME/repos/octo-org/octo-repo/subscription",
"commits_url": "https://HOSTNAME/repos/octo-org/octo-repo/commits{/sha}",
"git_commits_url": "https://HOSTNAME/repos/octo-org/octo-repo/git/commits{/sha}",
"comments_url": "https://HOSTNAME/repos/octo-org/octo-repo/comments{/number}",
"issue_comment_url": "https://HOSTNAME/repos/octo-org/octo-repo/issues/comments{/number}",
"contents_url": "https://HOSTNAME/repos/octo-org/octo-repo/contents/{+path}",
"compare_url": "https://HOSTNAME/repos/octo-org/octo-repo/compare/{base}...{head}",
"merges_url": "https://HOSTNAME/repos/octo-org/octo-repo/merges",
"archive_url": "https://HOSTNAME/repos/octo-org/octo-repo/{archive_format}{/ref}",
"downloads_url": "https://HOSTNAME/repos/octo-org/octo-repo/downloads",
"issues_url": "https://HOSTNAME/repos/octo-org/octo-repo/issues{/number}",
"pulls_url": "https://HOSTNAME/repos/octo-org/octo-repo/pulls{/number}",
"milestones_url": "https://HOSTNAME/repos/octo-org/octo-repo/milestones{/number}",
"notifications_url": "https://HOSTNAME/repos/octo-org/octo-repo/notifications{?since,all,participating}",
"labels_url": "https://HOSTNAME/repos/octo-org/octo-repo/labels{/name}",
"releases_url": "https://HOSTNAME/repos/octo-org/octo-repo/releases{/id}",
"deployments_url": "https://HOSTNAME/repos/octo-org/octo-repo/deployments"
}
}
Download workflow run attempt logs
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 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.
Parâmetros para "Download workflow run attempt logs"
Cabeçalhos |
---|
Name, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Name, Tipo, Descrição |
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository. The name is not case sensitive. |
run_id integer ObrigatórioThe unique identifier of the workflow run. |
attempt_number integer ObrigatórioThe attempt number of the workflow run. |
Códigos de status de resposta HTTP para "Download workflow run attempt logs"
Código de status | Descrição |
---|---|
302 | Found |
Exemplos de código para "Download workflow run attempt logs"
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/runs/RUN_ID/attempts/ATTEMPT_NUMBER/logs
Response
Status: 302
Cancel a workflow run
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.
Parâmetros para "Cancel a workflow run"
Cabeçalhos |
---|
Name, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Name, Tipo, Descrição |
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository. The name is not case sensitive. |
run_id integer ObrigatórioThe unique identifier of the workflow run. |
Códigos de status de resposta HTTP para "Cancel a workflow run"
Código de status | Descrição |
---|---|
202 | Accepted |
409 | Conflict |
Exemplos de código para "Cancel a workflow run"
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/runs/RUN_ID/cancel
Response
Status: 202
Download workflow run logs
Gets 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.
Parâmetros para "Download workflow run logs"
Cabeçalhos |
---|
Name, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Name, Tipo, Descrição |
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository. The name is not case sensitive. |
run_id integer ObrigatórioThe unique identifier of the workflow run. |
Códigos de status de resposta HTTP para "Download workflow run logs"
Código de status | Descrição |
---|---|
302 | Found |
Exemplos de código para "Download workflow run logs"
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/runs/RUN_ID/logs
Response
Status: 302
Delete workflow run logs
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.
Parâmetros para "Delete workflow run logs"
Cabeçalhos |
---|
Name, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Name, Tipo, Descrição |
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository. The name is not case sensitive. |
run_id integer ObrigatórioThe unique identifier of the workflow run. |
Códigos de status de resposta HTTP para "Delete workflow run logs"
Código de status | Descrição |
---|---|
204 | No Content |
403 | Forbidden |
500 | Internal Error |
Exemplos de código para "Delete workflow run logs"
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/runs/RUN_ID/logs
Response
Status: 204
Get pending deployments for a workflow run
Get all deployment environments for a workflow run that are waiting for protection rules to pass.
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.
Parâmetros para "Get pending deployments for a workflow run"
Cabeçalhos |
---|
Name, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Name, Tipo, Descrição |
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository. The name is not case sensitive. |
run_id integer ObrigatórioThe unique identifier of the workflow run. |
Códigos de status de resposta HTTP para "Get pending deployments for a workflow run"
Código de status | Descrição |
---|---|
200 | OK |
Exemplos de código para "Get pending deployments for a workflow run"
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/runs/RUN_ID/pending_deployments
Response
Status: 200
[
{
"environment": {
"id": 161088068,
"node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4",
"name": "staging",
"url": "https://HOSTNAME/repos/github/hello-world/environments/staging",
"html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging"
},
"wait_timer": 30,
"wait_timer_started_at": "2020-11-23T22:00:40Z",
"current_user_can_approve": true,
"reviewers": [
{
"type": "User",
"reviewer": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
}
},
{
"type": "Team",
"reviewer": {
"id": 1,
"node_id": "MDQ6VGVhbTE=",
"url": "https://HOSTNAME/teams/1",
"html_url": "https://github.com/orgs/github/teams/justice-league",
"name": "Justice League",
"slug": "justice-league",
"description": "A great team.",
"privacy": "closed",
"permission": "admin",
"members_url": "https://HOSTNAME/teams/1/members{/member}",
"repositories_url": "https://HOSTNAME/teams/1/repos",
"parent": null
}
}
]
}
]
Review pending deployments for a workflow run
Approve or reject pending deployments that are waiting on approval by a required reviewer.
Required reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the repo
scope to use this endpoint.
Parâmetros para "Review pending deployments for a workflow run"
Cabeçalhos |
---|
Name, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Name, Tipo, Descrição |
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository. The name is not case sensitive. |
run_id integer ObrigatórioThe unique identifier of the workflow run. |
Parâmetros do corpo |
Name, Tipo, Descrição |
environment_ids array of integers ObrigatórioThe list of environment ids to approve or reject |
state string ObrigatórioWhether to approve or reject deployment to the specified environments. Pode ser um dos: |
comment string ObrigatórioA comment to accompany the deployment review |
Códigos de status de resposta HTTP para "Review pending deployments for a workflow run"
Código de status | Descrição |
---|---|
200 | OK |
Exemplos de código para "Review pending deployments for a workflow run"
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/runs/RUN_ID/pending_deployments \
-d '{"environment_ids":[161171787],"state":"approved","comment":"Ship it!"}'
Response
Status: 200
[
{
"url": "https://HOSTNAME/repos/octocat/example/deployments/1",
"id": 1,
"node_id": "MDEwOkRlcGxveW1lbnQx",
"sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d",
"ref": "topic-branch",
"task": "deploy",
"payload": {},
"original_environment": "staging",
"environment": "production",
"description": "Deploy request from hubot",
"creator": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"created_at": "2012-07-20T01:19:13Z",
"updated_at": "2012-07-20T01:19:13Z",
"statuses_url": "https://HOSTNAME/repos/octocat/example/deployments/1/statuses",
"repository_url": "https://HOSTNAME/repos/octocat/example",
"transient_environment": false,
"production_environment": true
}
]
Re-run a workflow
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.
Parâmetros para "Re-run a workflow"
Cabeçalhos |
---|
Name, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Name, Tipo, Descrição |
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository. The name is not case sensitive. |
run_id integer ObrigatórioThe unique identifier of the workflow run. |
Parâmetros do corpo |
Name, Tipo, Descrição |
enable_debug_logging boolean Whether to enable debug logging for the re-run. Padrão: |
Códigos de status de resposta HTTP para "Re-run a workflow"
Código de status | Descrição |
---|---|
201 | Created |
Exemplos de código para "Re-run a workflow"
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/runs/RUN_ID/rerun
Response
Status: 201
Re-run failed jobs from a workflow run
Re-run all of the failed jobs and their dependent jobs in a workflow run using the id
of the workflow run. You must authenticate using an access token with the repo
scope to use this endpoint.
Parâmetros para "Re-run failed jobs from a workflow run"
Cabeçalhos |
---|
Name, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Name, Tipo, Descrição |
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository. The name is not case sensitive. |
run_id integer ObrigatórioThe unique identifier of the workflow run. |
Parâmetros do corpo |
Name, Tipo, Descrição |
enable_debug_logging boolean Whether to enable debug logging for the re-run. Padrão: |
Códigos de status de resposta HTTP para "Re-run failed jobs from a workflow run"
Código de status | Descrição |
---|---|
201 | Created |
Exemplos de código para "Re-run failed jobs from a workflow run"
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/runs/RUN_ID/rerun-failed-jobs
Response
Status: 201
List workflow runs for a workflow
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.
Parâmetros para "List workflow runs for a workflow"
Cabeçalhos |
---|
Name, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Name, Tipo, Descrição |
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository. The name is not case sensitive. |
workflow_id ObrigatórioThe ID of the workflow. You can also pass the workflow file name as a string. |
Parâmetros de consulta |
Name, Tipo, Descrição |
actor string Returns someone's workflow runs. Use the login for the user who created the |
branch string Returns workflow runs associated with a branch. Use the name of the branch of the |
event string Returns workflow run triggered by the event you specify. For example, |
status string Returns workflow runs with the check run Pode ser um dos: |
per_page integer The number of results per page (max 100). Padrão: |
page integer Page number of the results to fetch. Padrão: |
created string Returns workflow runs created within the given date-time range. For more information on the syntax, see "Understanding the search syntax." |
exclude_pull_requests boolean If Padrão: |
check_suite_id integer Returns workflow runs with the |
head_sha string Only returns workflow runs that are associated with the specified |
Códigos de status de resposta HTTP para "List workflow runs for a workflow"
Código de status | Descrição |
---|---|
200 | OK |
Exemplos de código para "List workflow runs for a workflow"
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/workflows/WORKFLOW_ID/runs
Response
Status: 200
{
"total_count": 1,
"workflow_runs": [
{
"id": 30433642,
"name": "Build",
"node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==",
"check_suite_id": 42,
"check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==",
"head_branch": "master",
"head_sha": "acb5820ced9479c074f688cc328bf03f341a511d",
"run_number": 562,
"event": "push",
"status": "queued",
"conclusion": null,
"workflow_id": 159038,
"url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/runs/30433642",
"html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642",
"pull_requests": [],
"created_at": "2020-01-22T19:33:08Z",
"updated_at": "2020-01-22T19:33:08Z",
"actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"run_attempt": 1,
"run_started_at": "2020-01-22T19:33:08Z",
"triggering_actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"jobs_url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/runs/30433642/jobs",
"logs_url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/runs/30433642/logs",
"check_suite_url": "https://HOSTNAME/repos/octo-org/octo-repo/check-suites/414944374",
"artifacts_url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/runs/30433642/artifacts",
"cancel_url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/runs/30433642/cancel",
"rerun_url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/runs/30433642/rerun",
"workflow_url": "https://HOSTNAME/repos/octo-org/octo-repo/actions/workflows/159038",
"head_commit": {
"id": "acb5820ced9479c074f688cc328bf03f341a511d",
"tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223",
"message": "Create linter.yaml",
"timestamp": "2020-01-22T19:33:05Z",
"author": {
"name": "Octo Cat",
"email": "octocat@github.com"
},
"committer": {
"name": "GitHub",
"email": "noreply@github.com"
}
},
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"private": false,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": false,
"url": "https://HOSTNAME/repos/octocat/Hello-World",
"archive_url": "https://HOSTNAME/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://HOSTNAME/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://HOSTNAME/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://HOSTNAME/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://HOSTNAME/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://HOSTNAME/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://HOSTNAME/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://HOSTNAME/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://HOSTNAME/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://HOSTNAME/repos/octocat/Hello-World/contributors",
"deployments_url": "https://HOSTNAME/repos/octocat/Hello-World/deployments",
"downloads_url": "https://HOSTNAME/repos/octocat/Hello-World/downloads",
"events_url": "https://HOSTNAME/repos/octocat/Hello-World/events",
"forks_url": "https://HOSTNAME/repos/octocat/Hello-World/forks",
"git_commits_url": "https://HOSTNAME/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://HOSTNAME/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://HOSTNAME/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://HOSTNAME/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://HOSTNAME/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://HOSTNAME/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://HOSTNAME/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://HOSTNAME/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://HOSTNAME/repos/octocat/Hello-World/languages",
"merges_url": "https://HOSTNAME/repos/octocat/Hello-World/merges",
"milestones_url": "https://HOSTNAME/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://HOSTNAME/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://HOSTNAME/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://HOSTNAME/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://HOSTNAME/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://HOSTNAME/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://HOSTNAME/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://HOSTNAME/repos/octocat/Hello-World/subscription",
"tags_url": "https://HOSTNAME/repos/octocat/Hello-World/tags",
"teams_url": "https://HOSTNAME/repos/octocat/Hello-World/teams",
"trees_url": "https://HOSTNAME/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "http://HOSTNAME/repos/octocat/Hello-World/hooks"
},
"head_repository": {
"id": 217723378,
"node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
"name": "octo-repo",
"full_name": "octo-org/octo-repo",
"private": true,
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"html_url": "https://github.com/octo-org/octo-repo",
"description": null,
"fork": false,
"url": "https://HOSTNAME/repos/octo-org/octo-repo",
"forks_url": "https://HOSTNAME/repos/octo-org/octo-repo/forks",
"keys_url": "https://HOSTNAME/repos/octo-org/octo-repo/keys{/key_id}",
"collaborators_url": "https://HOSTNAME/repos/octo-org/octo-repo/collaborators{/collaborator}",
"teams_url": "https://HOSTNAME/repos/octo-org/octo-repo/teams",
"hooks_url": "https://HOSTNAME/repos/octo-org/octo-repo/hooks",
"issue_events_url": "https://HOSTNAME/repos/octo-org/octo-repo/issues/events{/number}",
"events_url": "https://HOSTNAME/repos/octo-org/octo-repo/events",
"assignees_url": "https://HOSTNAME/repos/octo-org/octo-repo/assignees{/user}",
"branches_url": "https://HOSTNAME/repos/octo-org/octo-repo/branches{/branch}",
"tags_url": "https://HOSTNAME/repos/octo-org/octo-repo/tags",
"blobs_url": "https://HOSTNAME/repos/octo-org/octo-repo/git/blobs{/sha}",
"git_tags_url": "https://HOSTNAME/repos/octo-org/octo-repo/git/tags{/sha}",
"git_refs_url": "https://HOSTNAME/repos/octo-org/octo-repo/git/refs{/sha}",
"trees_url": "https://HOSTNAME/repos/octo-org/octo-repo/git/trees{/sha}",
"statuses_url": "https://HOSTNAME/repos/octo-org/octo-repo/statuses/{sha}",
"languages_url": "https://HOSTNAME/repos/octo-org/octo-repo/languages",
"stargazers_url": "https://HOSTNAME/repos/octo-org/octo-repo/stargazers",
"contributors_url": "https://HOSTNAME/repos/octo-org/octo-repo/contributors",
"subscribers_url": "https://HOSTNAME/repos/octo-org/octo-repo/subscribers",
"subscription_url": "https://HOSTNAME/repos/octo-org/octo-repo/subscription",
"commits_url": "https://HOSTNAME/repos/octo-org/octo-repo/commits{/sha}",
"git_commits_url": "https://HOSTNAME/repos/octo-org/octo-repo/git/commits{/sha}",
"comments_url": "https://HOSTNAME/repos/octo-org/octo-repo/comments{/number}",
"issue_comment_url": "https://HOSTNAME/repos/octo-org/octo-repo/issues/comments{/number}",
"contents_url": "https://HOSTNAME/repos/octo-org/octo-repo/contents/{+path}",
"compare_url": "https://HOSTNAME/repos/octo-org/octo-repo/compare/{base}...{head}",
"merges_url": "https://HOSTNAME/repos/octo-org/octo-repo/merges",
"archive_url": "https://HOSTNAME/repos/octo-org/octo-repo/{archive_format}{/ref}",
"downloads_url": "https://HOSTNAME/repos/octo-org/octo-repo/downloads",
"issues_url": "https://HOSTNAME/repos/octo-org/octo-repo/issues{/number}",
"pulls_url": "https://HOSTNAME/repos/octo-org/octo-repo/pulls{/number}",
"milestones_url": "https://HOSTNAME/repos/octo-org/octo-repo/milestones{/number}",
"notifications_url": "https://HOSTNAME/repos/octo-org/octo-repo/notifications{?since,all,participating}",
"labels_url": "https://HOSTNAME/repos/octo-org/octo-repo/labels{/name}",
"releases_url": "https://HOSTNAME/repos/octo-org/octo-repo/releases{/id}",
"deployments_url": "https://HOSTNAME/repos/octo-org/octo-repo/deployments"
}
}
]
}