ownerstringrequired
repostringrequired
commit_shastringrequired
commit_sha parameter
Get a commit
Gets a Git commit object.
Signature verification object
The response will include a verification object that describes the result of verifying the commit’s signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified |
boolean |
Indicates whether GitHub considers the signature in this commit to be verified. |
reason |
string |
The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature |
string |
The signature that was extracted from the commit. |
payload |
string |
The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key |
The key that made the signature is expired. |
not_signing_key |
The “signing” flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error |
There was an error communicating with the signature verification service. |
gpgverify_unavailable |
The signature verification service is currently unavailable. |
unsigned |
The object does not include a signature. |
unknown_signature_type |
A non-PGP signature was found in the commit. |
no_user |
No user was associated with the committer email address in the commit. |
unverified_email |
The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email |
The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key |
The key that made the signature has not been registered with any user’s account. |
malformed_signature |
There was an error parsing the signature. |
invalid |
The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid |
None of the above errors applied, so the signature is considered to be verified. |
get
{protocol}://{hostname}/api/v3/repos/{owner}/{repo}/git/commits/{commit_sha}
Path Parameters
Response
application/json
Response
application/json
Response
Git Commit
Low-level Git commit operations within a repository
shastringrequired
SHA for the commit
Example:7638417db6d59f3c431d3e1f261cc637155684cd
node_idstringrequired
urlstring(uri)required
authorobjectrequired
Identifying information for the git-user
Show Child Parameters
committerobjectrequired
Identifying information for the git-user
Show Child Parameters
messagestringrequired
Message describing the purpose of the commit
Example:Fix #42
treeobjectrequired
Show Child Parameters
parentsarray[object]required
Show Child Parameters
verificationobjectrequired
Show Child Parameters
html_urlstring(uri)required
get/repos/{owner}/{repo}/git/commits/{commit_sha}
Path Parameters
application/json
List matching references
Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn’t exist in the repository, but existing refs start with :ref, they will be returned as an array.
When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.
Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see “Checking mergeability of pull requests”.
If you request matching references for a branch named feature but the branch feature doesn’t exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.
get
{protocol}://{hostname}/api/v3/repos/{owner}/{repo}/git/matching-refs/{ref}
Query Parameters
per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
Path Parameters
ownerstringrequired
repostringrequired
refstringrequired
ref parameter
Response
200 application/json
Response
200 application/json
Response
Git references within a repository
refstringrequired
node_idstringrequired
urlstring(uri)required
objectobjectrequired
Show Child Parameters
get/repos/{owner}/{repo}/git/matching-refs/{ref}
Path Parameters
Query Parameters
200 application/json
Get a reference
Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn’t match an existing ref, a 404 is returned.
Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see “Checking mergeability of pull requests”.
get
{protocol}://{hostname}/api/v3/repos/{owner}/{repo}/git/ref/{ref}
Path Parameters
ownerstringrequired
repostringrequired
refstringrequired
ref parameter
Response
application/json
Response
application/json
Response
Git Reference
Git references within a repository
refstringrequired
node_idstringrequired
urlstring(uri)required
objectobjectrequired
Show Child Parameters
get/repos/{owner}/{repo}/git/ref/{ref}
Path Parameters
application/json
Create a reference
Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.
post
{protocol}://{hostname}/api/v3/repos/{owner}/{repo}/git/refs
Path Parameters
ownerstringrequired
repostringrequired
Body
application/json
Body
application/json
refstringrequired
The name of the fully qualified reference (ie: refs/heads/master). If it doesn’t start with ‘refs’ and have at least two slashes, it will be rejected.
shastringrequired
The SHA1 value for this reference.
keystring
Example:"refs/heads/newbranch"
Response
application/json
Response
application/json
Response
Git Reference
Git references within a repository
refstringrequired
node_idstringrequired
urlstring(uri)required
objectobjectrequired
Show Child Parameters
post/repos/{owner}/{repo}/git/refs
Path Parameters
Body
{
"ref": "refs/heads/featureA",
"sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
}
application/json
Update a reference
patch
{protocol}://{hostname}/api/v3/repos/{owner}/{repo}/git/refs/{ref}
Path Parameters
ownerstringrequired
repostringrequired
refstringrequired
ref parameter
Body
application/json
Body
application/json
shastringrequired
The SHA1 value to set this reference to
forceboolean
Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you’re not overwriting work.
Default:false
Response
application/json
Response
application/json
Response
Git Reference
Git references within a repository
refstringrequired
node_idstringrequired
urlstring(uri)required
objectobjectrequired
Show Child Parameters
patch/repos/{owner}/{repo}/git/refs/{ref}
Path Parameters
Body
{
"sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
"force": true
}
application/json