Pontos de extremidade da API REST para execuções de fluxo de trabalho

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 Gerenciando execuções e implantações de fluxo de trabalho.

Re-run a job from a workflow run

Re-run a job and its dependent jobs in a workflow run.

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

Tokens de acesso refinados para "Re-run a job from a workflow run"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Actions" repository permissions (write)

Parâmetros para "Re-run a job from a workflow run"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.
`job_id` integer Obrigatório The unique identifier of the job.

Parâmetros do corpo
Nome, Tipo, Descrição
`enable_debug_logging` boolean Whether to enable debug logging for the re-run. Padrão: `false`

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"

Exemplo de solicitação

post/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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.

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

This endpoint will return up to 1,000 results for each search when using the following parameters: actor, branch, check_suite_id, created, event, head_sha, status.

Tokens de acesso refinados para "List workflow runs for a repository"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Actions" repository permissions (read)

Esse ponto de extremidade pode ser usado sem autenticação ou as permissões acima mencionadas se apenas recursos públicos forem solicitados.

Parâmetros para "List workflow runs for a repository"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.

Parâmetros de consulta
Nome, Tipo, Descrição
`actor` string Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.
`branch` string Returns workflow runs associated with a branch. Use the name of the branch of the `push`.
`event` string Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "Events that trigger workflows."
`status` string Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. Pode ser um dos: `completed`, `action_required`, `cancelled`, `failure`, `neutral`, `skipped`, `stale`, `success`, `timed_out`, `in_progress`, `queued`, `requested`, `waiting`, `pending`
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Padrão: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Padrão: `1`
`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 `true` pull requests are omitted from the response (empty array). Padrão: `false`
`check_suite_id` integer Returns workflow runs with the `check_suite_id` that you specify.
`head_sha` string Only returns workflow runs that are associated with the specified `head_sha`.

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"

Exemplo de solicitação

get/repos/{owner}/{repo}/actions/runs

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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",
      "path": ".github/workflows/build.yml@main",
      "run_number": 562,
      "event": "push",
      "display_title": "Update README.md",
      "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.

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

Tokens de acesso refinados para "Get a workflow run"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Actions" repository permissions (read)

Esse ponto de extremidade pode ser usado sem autenticação ou as permissões acima mencionadas se apenas recursos públicos forem solicitados.

Parâmetros para "Get a workflow run"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.
`run_id` integer Obrigatório The unique identifier of the workflow run.

Parâmetros de consulta
Nome, Tipo, Descrição
`exclude_pull_requests` boolean If `true` pull requests are omitted from the response (empty array). Padrão: `false`

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"

Exemplo de solicitação

get/repos/{owner}/{repo}/actions/runs/{run_id}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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",
  "display_title": "Update README.md",
  "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,
  "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

Deletes a specific workflow run.

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

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

Tokens de acesso refinados para "Delete a workflow run"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Actions" repository permissions (write)

Parâmetros para "Delete a workflow run"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.
`run_id` integer Obrigatório The 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"

Exemplo de solicitação

delete/repos/{owner}/{repo}/actions/runs/{run_id}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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.

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

Tokens de acesso refinados para "Get the review history for a workflow run"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Actions" repository permissions (read)

Esse ponto de extremidade pode ser usado sem autenticação ou as permissões acima mencionadas se apenas recursos públicos forem solicitados.

Parâmetros para "Get the review history for a workflow run"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.
`run_id` integer Obrigatório The 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"

Exemplo de solicitação

get/repos/{owner}/{repo}/actions/runs/{run_id}/approvals

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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.

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

Tokens de acesso refinados para "Get a workflow run attempt"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Actions" repository permissions (read)

Esse ponto de extremidade pode ser usado sem autenticação ou as permissões acima mencionadas se apenas recursos públicos forem solicitados.

Parâmetros para "Get a workflow run attempt"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.
`run_id` integer Obrigatório The unique identifier of the workflow run.
`attempt_number` integer Obrigatório The attempt number of the workflow run.

Parâmetros de consulta
Nome, Tipo, Descrição
`exclude_pull_requests` boolean If `true` pull requests are omitted from the response (empty array). Padrão: `false`

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"

Exemplo de solicitação

get/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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",
  "display_title": "Update README.md",
  "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,
  "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, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

Tokens de acesso refinados para "Download workflow run attempt logs"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Actions" repository permissions (read)

Esse ponto de extremidade pode ser usado sem autenticação ou as permissões acima mencionadas se apenas recursos públicos forem solicitados.

Parâmetros para "Download workflow run attempt logs"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.
`run_id` integer Obrigatório The unique identifier of the workflow run.
`attempt_number` integer Obrigatório The 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"

Exemplo de solicitação

get/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

Tokens de acesso refinados para "Cancel a workflow run"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Actions" repository permissions (write)

Parâmetros para "Cancel a workflow run"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.
`run_id` integer Obrigatório The 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"

Exemplo de solicitação

post/repos/{owner}/{repo}/actions/runs/{run_id}/cancel

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/runs/RUN_ID/cancel

Response

Status: 202

Review custom deployment protection rules for a workflow run

Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "Using environments for deployment."

Note

GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.

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

Tokens de acesso refinados para "Review custom deployment protection rules for a workflow run"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

Tokens de acesso à instalação do aplicativo GitHub

O token refinado deve ter os seguintes conjuntos de permissões:

"Deployments" repository permissions (write)

Parâmetros para "Review custom deployment protection rules for a workflow run"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.
`run_id` integer Obrigatório The unique identifier of the workflow run.

Códigos de status de resposta HTTP para "Review custom deployment protection rules for a workflow run"

Código de status	Descrição
`204`	No Content

Exemplos de código para "Review custom deployment protection rules for a workflow run"

Exemplo de solicitação

post/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/runs/RUN_ID/deployment_protection_rule \
  -d '{"environment_name":"prod-eus","state":"approved","comment":"All health checks passed."}'

Response

Status: 204

Force cancel a workflow run

Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an always() condition on a job. You should only use this endpoint to cancel a workflow run when the workflow run is not responding to POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

Tokens de acesso refinados para "Force cancel a workflow run"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Actions" repository permissions (write)

Parâmetros para "Force cancel a workflow run"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.
`run_id` integer Obrigatório The unique identifier of the workflow run.

Códigos de status de resposta HTTP para "Force cancel a workflow run"

Código de status	Descrição
`202`	Accepted
`409`	Conflict

Exemplos de código para "Force cancel a workflow run"

Exemplo de solicitação

post/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/actions/runs/RUN_ID/force-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, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

Tokens de acesso refinados para "Download workflow run logs"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Actions" repository permissions (read)

Esse ponto de extremidade pode ser usado sem autenticação ou as permissões acima mencionadas se apenas recursos públicos forem solicitados.

Parâmetros para "Download workflow run logs"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.
`run_id` integer Obrigatório The 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"

Exemplo de solicitação

get/repos/{owner}/{repo}/actions/runs/{run_id}/logs

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

Tokens de acesso refinados para "Delete workflow run logs"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Actions" repository permissions (write)

Parâmetros para "Delete workflow run logs"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.
`run_id` integer Obrigatório The 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"

Exemplo de solicitação

delete/repos/{owner}/{repo}/actions/runs/{run_id}/logs

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

Tokens de acesso refinados para "Get pending deployments for a workflow run"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Actions" repository permissions (read)

Esse ponto de extremidade pode ser usado sem autenticação ou as permissões acima mencionadas se apenas recursos públicos forem solicitados.

Parâmetros para "Get pending deployments for a workflow run"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.
`run_id` integer Obrigatório The 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"

Exemplo de solicitação

get/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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",
          "notification_setting": "notifications_enabled",
          "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.

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

Tokens de acesso refinados para "Review pending deployments for a workflow run"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Actions" repository permissions (read) and "Checks" repository permissions (read) and "Deployments" repository permissions (read)

Parâmetros para "Review pending deployments for a workflow run"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.
`run_id` integer Obrigatório The unique identifier of the workflow run.

Parâmetros do corpo
Nome, Tipo, Descrição
`environment_ids` array of integers Obrigatório The list of environment ids to approve or reject
`state` string Obrigatório Whether to approve or reject deployment to the specified environments. Pode ser um dos: `approved`, `rejected`
`comment` string Obrigatório A 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"

Exemplo de solicitação

post/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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.

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

Tokens de acesso refinados para "Re-run a workflow"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Actions" repository permissions (write)

Parâmetros para "Re-run a workflow"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.
`run_id` integer Obrigatório The unique identifier of the workflow run.

Parâmetros do corpo
Nome, Tipo, Descrição
`enable_debug_logging` boolean Whether to enable debug logging for the re-run. Padrão: `false`

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"

Exemplo de solicitação

post/repos/{owner}/{repo}/actions/runs/{run_id}/rerun

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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.

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

Tokens de acesso refinados para "Re-run failed jobs from a workflow run"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Actions" repository permissions (write)

Parâmetros para "Re-run failed jobs from a workflow run"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.
`run_id` integer Obrigatório The unique identifier of the workflow run.

Parâmetros do corpo
Nome, Tipo, Descrição
`enable_debug_logging` boolean Whether to enable debug logging for the re-run. Padrão: `false`

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"

Exemplo de solicitação

post/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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

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

This endpoint will return up to 1,000 results for each search when using the following parameters: actor, branch, check_suite_id, created, event, head_sha, status.

Tokens de acesso refinados para "List workflow runs for a workflow"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Actions" repository permissions (read)

Esse ponto de extremidade pode ser usado sem autenticação ou as permissões acima mencionadas se apenas recursos públicos forem solicitados.

Parâmetros para "List workflow runs for a workflow"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`owner` string Obrigatório The account owner of the repository. The name is not case sensitive.
`repo` string Obrigatório The name of the repository without the `.git` extension. The name is not case sensitive.
`workflow_id` Obrigatório The ID of the workflow. You can also pass the workflow file name as a string.

Parâmetros de consulta
Nome, Tipo, Descrição
`actor` string Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.
`branch` string Returns workflow runs associated with a branch. Use the name of the branch of the `push`.
`event` string Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "Events that trigger workflows."
`status` string Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. Pode ser um dos: `completed`, `action_required`, `cancelled`, `failure`, `neutral`, `skipped`, `stale`, `success`, `timed_out`, `in_progress`, `queued`, `requested`, `waiting`, `pending`
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Padrão: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Padrão: `1`
`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 `true` pull requests are omitted from the response (empty array). Padrão: `false`
`check_suite_id` integer Returns workflow runs with the `check_suite_id` that you specify.
`head_sha` string Only returns workflow runs that are associated with the specified `head_sha`.

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"

Exemplo de solicitação

get/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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",
      "path": ".github/workflows/build.yml@main",
      "run_number": 562,
      "event": "push",
      "display_title": "Update README.md",
      "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"
      }
    }
  ]
}