Commits

Enterprise Cloud

Enterprise Server

Enterprise Server 3.5

Enterprise Server 3.6

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

REST API

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Help us make these docs great!

Help for wherever you are on your GitHub journey.

Can be one of

Name

All {{ name }} guides

{{ name }} learning paths

Actions

GitHub began rolling these changes out to enterprises on

Enter a search term to find it in the GitHub Docs.

Commits - GitHub Enterprise Server 3.5 Docs

Use the REST API to interact with commits.

English

Simplified Chinese

Spanish

Portuguese

Russian

Japanese

French

German

Korean

Quickstart

About GitHub's APIs

Resources in the REST API

Media types

Authenticating

Keeping API credentials secure

Troubleshooting

Libraries

OpenAPI description

Endpoints for GitHub App installation tokens

Endpoints for GitHub App user tokens

Permissions for GitHub Apps

Overview

Using the API

Script with JavaScript

Discover resources for a user

Delivering deployments

Rendering data as graphs

Working with comments

Pagination

Building a CI server

Integrator best practices

Get started - Git database

Get started - Checks

Guides

Artifacts

Cache

Permissions

Secrets

Self-hosted runner groups

Self-hosted runners

Workflow jobs

Workflow runs

Workflows

Events

Feeds

Notifications

Starring

Watching

Activity

GitHub Apps

Installations

OAuth Authorizations

Webhooks

Apps

Billing

Branches

Protected branches

Check Runs

Check Suites

Checks

Codes of conduct

Code Scanning

Collaborators

Invitations

Commit comments

Commit statuses

Dependabot

Deploy keys

Deployment branch policies

Deployments

Environments

Deployment statuses

Emojis

Admin stats

Announcement

Audit log

Global Webhooks

LDAP

License

Management Console

Organization Pre-receive Hooks

Organizations

Pre-receive Environments

Pre-receive Hooks

Repository Pre-receive Hooks

Users

Enterprise administration

Gists

Comments

Blobs

References

Trees

Git database

Gitignore

Issues

Assignees

Labels

Milestones

Timeline

Licenses

Markdown

Statistics

Metrics

Migrations

OAuth authorizations

Custom Repository Roles

Members

Outside Collaborators

Pages

Boards

Cards

Columns

Project boards

Pulls

Review comments

Review requests

Reviews

Rate limit

Reactions

Releases

Release Assets

Autolinks

Forks

Git LFS

Repositories

Search

Secret scanning

Teams

Discussion comments

Discussions

Emails

Followers

GPG Keys

Git SSH Keys

Repository Webhook Configuration

Repository Webhook Deliveries

Repository Webhooks

Repository webhooks

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 notifications 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/enterprise-server@3.5/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/enterprise-server@3.5/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/enterprise-server@3.5/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