Pulls

Enterprise Cloud

Enterprise Server 3.10

Enterprise Server 3.11

Enterprise Server 3.6

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

REST API

Toda a documentação do GitHub é de código aberto. Encontrou informações erradas ou confusas? Envie uma solicitação de pull.

Ajude-nos a tornar esses documentos ótimos!

Ações

Digite um termo de pesquisa a encontrar na Documentação do GitHub.

Pulls - GitHub AE Docs

Use a API REST para gerenciar solicitações de pull e revisões de solicitação de pull.

Início Rápido

Comparando APIs do GitHub

Recursos na API REST

Rate limits

Tipos de mídia

Autenticação

Manter credenciais de API seguras

Solução de problemas

Libraries

Tipos de eventos de problemas

Tipos de eventos do GitHub

Pontos de extremidade para tokens de instalação do aplicativo GitHub

Pontos de extremidade para tokens de usuário do aplicativo GitHub

Permissões para aplicativos GitHub

Visão geral

Usando a API

Script com JavaScript

Script com Ruby

Descobrir recursos para um usuário

Entregar implantações

Representar dados como gráficos

Trabalhar com comentários

Paginação

Criar um servidor de CI

Práticas recomendadas

Introdução – banco de dados Git

Introdução – Verificações

Criptografar segredos

Guides

Artifacts

Permissões

Segredos

Grupos de runner auto-hospedados

Executores auto-hospedados

Trabalhos de fluxo de trabalho

Execução de fluxo de trabalho

Fluxos de trabalho

Eventos

Feeds

Notificações

Marcar com uma estrela

Observando

Atividade

Aplicativos GitHub

Instalações

Autorizações do OAuth

Webhooks

Aplicativos

Branches

Branches protegidos

Execuções de verificação

conjuntos de verificações

Verificações

Verificação de código

Códigos de conduta

Colaboradores

Convites

Confirmações

Comentários de commit

Status do commit

Chaves de implantação

Políticas de branch de implantação

Implantações

Ambientes

Status da implantação

Emojis

Estatísticas de admin

Anúncio

Log de auditoria

Webhooks globais

Licença

Organizações

Ambientes Pre-receive

Usuários

Administração de empresas

Gists

Comentários

Blobs

Referências

Marcações

Árvores

Banco de dados do Git

Gitignore

Problemas

Responsáveis

Rótulos

Marcos

Linha do tempo

Licenças

Markdown

Estatísticas

Métricas

Migrações

Membros

Colaboradores externos

Páginas

Boards

Cartões

Colunas

Project boards

Comentários de opiniões

Solicitações de revisão

Análises

Limite de taxa

Reações

Versões

Ativos de versões

Links automáticos

Sumário

Garfos

Git LFS

Repositórios

Search

Verificação de segredo

Teams

Comentários da discussão

Discussões

Grupos externos

Seguidores

Chaves GPG

Chaves SSH do Git

API REST

v1.0

Amazing new feature

Pull Request Simple

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see <a href="https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products">GitHub's products</a> in the GitHub Help documentation.

The account owner of the repository. The name is not case sensitive.

owner

The name of the repository without the <code>.git</code> extension. The name is not case sensitive.

repo

Either <code>open</code>, <code>closed</code>, or <code>all</code> to filter by state.

state

Filter pulls by head user or head organization and branch name in the format of <code>user:ref-name</code> or <code>organization:ref-name</code>. For example: <code>github:new-script-format</code> or <code>octocat:test-branch</code>.

head

Filter pulls by base branch name. Example: <code>gh-pages</code>.

base

What to sort results by. <code>popularity</code> will sort by the number of comments. <code>long-running</code> will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.

sort

The direction of the sort. Default: <code>desc</code> when sort is <code>created</code> or sort is not specified, otherwise <code>asc</code>.

direction

The number of results per page (max 100).

per_page

Page number of the results to fetch.

page

Validation failed, or the endpoint has been spammed.

List pull requests

The title of the new pull request. Required unless <code>issue</code> is specified.

title

The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace <code>head</code> with a user like this: <code>username:branch</code>.

The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

body

Indicates whether <a href="https://docs.github.com/github-ae@latest/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/">maintainers can modify</a> the pull request.

maintainer_can_modify

Indicates whether the pull request is a draft. See "<a href="https://docs.github.com/github-ae@latest/articles/about-pull-requests#draft-pull-requests">Draft Pull Requests</a>" in the GitHub Help documentation to learn more.

draft

An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless <code>title</code> is specified.

issue

https://web.archive.org/web/20231125113943/https://api.github.com/repos/octocat/Hello-World/contents/{+path}

Hello-World

Justice League

Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.

How the author is associated with the repository.

author_association

The status of auto merging a pull request.

Auto merge

Indicates whether or not the pull request is a draft.

Indicates whether maintainers can modify the pull request.

Number uniquely identifying the pull request within its repository.

State of this Pull Request. Either `open` or `closed`.

Simple User

Pull Request

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see <a href="https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products">GitHub's products</a> in the GitHub Help documentation.
To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
This endpoint triggers <a href="https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "<a href="https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits">Rate limits for the API</a>" and "<a href="https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api">Best practices for using the REST API</a>."

Create a pull request

Pass the appropriate <a href="https://docs.github.com/github-ae@latest/rest/overview/media-types/#commits-commit-comparison-and-pull-requests">media type</a> to fetch diff and patch formats.

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see <a href="https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products">GitHub's products</a> in the GitHub Help documentation.
Lists details of a pull request by providing its number.
When you get, <a href="https://docs.github.com/github-ae@latest/rest/pulls/pulls/#create-a-pull-request">create</a>, or <a href="https://docs.github.com/github-ae@latest/rest/pulls/pulls#update-a-pull-request">edit</a> a pull request, GitHub AE creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the <code>mergeable</code> key. For more information, see "<a href="https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests">Checking mergeability of pull requests</a>".
The value of the <code>mergeable</code> attribute can be <code>true</code>, <code>false</code>, or <code>null</code>. If the value is <code>null</code>, then GitHub AE has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-<code>null</code> value for the <code>mergeable</code> attribute in the response. If <code>mergeable</code> is <code>true</code>, then <code>merge_commit_sha</code> will be the SHA of the test merge commit.
The value of the <code>merge_commit_sha</code> attribute changes depending on the state of the pull request. Before merging a pull request, the <code>merge_commit_sha</code> attribute holds the SHA of the test merge commit. After merging a pull request, the <code>merge_commit_sha</code> attribute changes depending on how you merged the pull request:
<ul>
<li>If merged as a <a href="https://docs.github.com/github-ae@latest/articles/about-merge-methods-on-github/">merge commit</a>, <code>merge_commit_sha</code> represents the SHA of the merge commit.</li>
<li>If merged via a <a href="https://docs.github.com/github-ae@latest/articles/about-merge-methods-on-github/#squashing-your-merge-commits">squash</a>, <code>merge_commit_sha</code> represents the SHA of the squashed commit on the base branch.</li>
<li>If <a href="https://docs.github.com/github-ae@latest/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits">rebased</a>, <code>merge_commit_sha</code> represents the commit that the base branch was updated to.</li>
</ul>
Pass the appropriate <a href="https://docs.github.com/github-ae@latest/rest/overview/media-types/#commits-commit-comparison-and-pull-requests">media type</a> to fetch diff and patch formats.

The number that identifies the pull request.

pull_number

Get a pull request

State of this Pull Request. Either <code>open</code> or <code>closed</code>.

The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

new title

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see <a href="https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products">GitHub's products</a> in the GitHub Help documentation.
To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

Update a pull request