Confirmaciones

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 la documentación de GitHub es de código abierto. ¿Ve algo incorrecto o que no esté claro? Envíe una solicitud de incorporación de cambios.

¡Ayúdanos a hacer geniales estos documentos!

Consulta el vídeo de esta transcripción.

Acciones

Introduzca un término de búsqueda para encontrarlo en la documentación de GitHub.

Confirmaciones - GitHub AE Docs

La API de REST puede usarse para interactuar con confirmaciones.

Inicio rápido

Comparación de las API de GitHub

Recursos en la API de REST

Rate limits

Tipos de medios

Autenticación

Protección de las credenciales de API

Troubleshooting

Libraries

Tipos de eventos de los informes de problemas

Tipos de evento de GitHub

Puntos de conexión para tokens de instalación de aplicaciones de GitHub

Puntos de conexión para tokens de usuario de aplicaciones de GitHub

Permisos para instancias de GitHub App

Información general

Uso de la API

Script con JavaScript

Script con Ruby

Descubrimiento de recursos para un usuario

Entregar despliegues

Representar los datos en gráficas

Trabajar con los comentarios

Paginación

Crear un servidor de IC

procedimientos recomendados

Introducción: base de datos de Git

Introducción: Comprobaciones

Cifrado de secretos

Guías

Artifacts

Permisos

Secretos

Grupos de ejecutores auto-hospedados

Ejecutores autohospedados

Jobs de los flujos de trabajo

Ejecuciones de flujo de trabajo

Workflows

Eventos

Fuentes

Notificaciones

Marcar con una estrella

Observando

Actividad

Aplicaciones de GitHub

Instalaciones

Autorizaciones de OAuth

webhooks

Aplicaciones

Ramas

Ramas protegidas

Ejecuciones de Verificación

Conjuntos de Verificaciones

Comprobaciones

Examen del código

Códigos de conducta

Colaboradores

Invitaciones

Comentarios sobre confirmación de cambios

Estados de confirmación

Claves de implementación

Directivas de rama de implementación

Implementaciones

Entornos

Estados de despliegue

Emojis

Estadísticas de los Administradores

Anuncio

Registro de auditoría

Webhooks globales

Licencia

Las organizaciones

Ambientes de pre-recepción

Usuarios

Administración empresarial

Gists

Comentarios

Datos BLOB

Referencias

Etiquetas

Árboles

Base de datos de Git

Gitignore

Incidencias

Asignados

Hitos

Escala de tiempo

Licencias

Markdown

Estadísticas

Métricas

Migraciones

Miembros

Colaboradores externos

Páginas

Boards

Cards

Columnas

Project boards

Extracciones

Revisar comentarios

Solicitudes de revisión

Revisiones

Límite de frecuencia

Reacciones

Versiones

Recursos de versión

Vínculos automáticos

Contenido

Horquillas

Git LFS

Repositorios

Webhooks

Search

Análisis de secretos

Teams

Comentarios de debate

Debates

Grupos externos

Seguidores

Claves GPG

Claves SSH de Git

API DE REST

Commit

<p><strong>Signature verification object</strong></p>
<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>






























<table><thead><tr><th scope="col">Name</th><th scope="col">Type</th><th scope="col">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>
<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>





























































<table><thead><tr><th scope="col">Value</th><th scope="col">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The "signing" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>

<p>The account owner of the repository. The name is not case sensitive.</p>

owner

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

repo

<p>SHA or branch to start listing commits from. Default: the repository’s default branch (usually <code>main</code>).</p>

<p>Only commits containing this file path will be returned.</p>

path

<p>GitHub username or email address to use to filter by commit author.</p>

author

<p>GitHub username or email address to use to filter by commit committer.</p>

committer

<p>Only show results that were last updated after the given time. This is a timestamp in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a> format: <code>YYYY-MM-DDTHH:MM:SSZ</code>.</p>

since

<p>Only commits before this date will be returned. This is a timestamp in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a> format: <code>YYYY-MM-DDTHH:MM:SSZ</code>.</p>

until

<p>The number of results per page (max 100).</p>

per_page

<p>Page number of the results to fetch.</p>

page

List commits

branch_5

Branch Short

<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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.</p>
<p>Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch.</p>

commit_sha

<p>Validation failed, or the endpoint has been spammed.</p>

List branches for HEAD commit

v1.0

Amazing new feature

Pull Request Simple

<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.</p>
<p>To list the open or merged pull requests associated with a branch, you can set the <code>commit_sha</code> parameter to the branch name.</p>

List pull requests associated with a commit

Monalisa Octocat

<p>Returns the contents of a single commit reference. You must have <code>read</code> access for the repository to use this endpoint.</p>
<p><strong>Note:</strong> If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.</p>
<p>You can 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 <code>diff</code> and <code>patch</code> formats. Diffs with binary data will have no <code>patch</code> property.</p>
<p>To return only the SHA-1 hash of the commit reference, you can provide the <code>sha</code> custom <a href="https://docs.github.com/github-ae@latest/rest/overview/media-types/#commits-commit-comparison-and-pull-requests">media type</a> in the <code>Accept</code> header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.</p>
<p><strong>Signature verification object</strong></p>
<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>






























<table><thead><tr><th scope="col">Name</th><th scope="col">Type</th><th scope="col">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>
<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>





























































<table><thead><tr><th scope="col">Value</th><th scope="col">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The "signing" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>

<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see "<a href="https://git-scm.com/book/en/v2/Git-Internals-Git-References">Git References</a>" in the Git documentation.</p>

Get a commit

https://web.archive.org/web/20231123142913/https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e

Commit Comparison

<p>Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "<a href="https://docs.github.com/github-ae@latest/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories">Understanding connections between repositories</a>."</p>
<p>This endpoint is equivalent to running the <code>git log BASE..HEAD</code> command, but it returns commits in a different order. The <code>git log BASE..HEAD</code> command returns commits in reverse chronological order, whereas the API returns commits in chronological order. You can 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.</p>
<p>The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a <code>renamed</code> status have a <code>previous_filename</code> field showing the previous filename of the file, and files with a <code>modified</code> status have a <code>patch</code> field showing the changes made to the file.</p>
<p>When calling this endpoint without any paging parameter (<code>per_page</code> or <code>page</code>), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.</p>
<p><strong>Working with large comparisons</strong></p>
<p>To process a response with a large number of commits, use a query parameter (<code>per_page</code> or <code>page</code>) to paginate the results. When using pagination:</p>
<ul>
<li>The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.</li>
<li>The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.</li>
</ul>
<p>For more information on working with pagination, see "<a href="https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api">Using pagination in the REST API</a>."</p>
<p><strong>Signature verification object</strong></p>
<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The <code>verification</code> object includes the following fields:</p>






























<table><thead><tr><th scope="col">Name</th><th scope="col">Type</th><th scope="col">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>
<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>





























































<table><thead><tr><th scope="col">Value</th><th scope="col">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The "signing" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>

<p>The base branch and head branch to compare. This parameter expects the format <code>BASE...HEAD</code>. Both must be branch names in <code>repo</code>. To compare with a branch that exists in a different repository in the same network as <code>repo</code>, the <code>basehead</code> parameter expects the format <code>USERNAME:BASE...USERNAME:HEAD</code>.</p>