ownerstringrequired
repostringrequired
comment_idintegerrequired
comment_id parameter
Update a commit comment
patch
{protocol}://{hostname}/api/v3/repos/{owner}/{repo}/comments/{comment_id}
Path Parameters
Body
application/json
Body
application/json
bodystringrequired
The contents of the comment
Response
application/json
Response
application/json
Response
Commit Comment
Commit Comment
html_urlstring(uri)required
urlstring(uri)required
idintegerrequired
node_idstringrequired
bodystringrequired
pathstring | nullrequired
positioninteger | nullrequired
lineinteger | nullrequired
commit_idstringrequired
userobject | nullrequired
Simple User
Show Child Parameters
created_atstring(date-time)required
updated_atstring(date-time)required
author_associationstringrequired
How the author is associated with the repository.
Allowed values:COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER
Example:OWNER
reactionsobject
Show Child Parameters
patch/repos/{owner}/{repo}/comments/{comment_id}
Path Parameters
Body
{
"body": "Nice change"
}
application/json
Delete a commit comment
delete
{protocol}://{hostname}/api/v3/repos/{owner}/{repo}/comments/{comment_id}
Path Parameters
ownerstringrequired
repostringrequired
comment_idintegerrequired
comment_id parameter
Response
Response
Response
delete/repos/{owner}/{repo}/comments/{comment_id}
Path Parameters
List commits
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}/commits
Query Parameters
shastring
SHA or branch to start listing commits from. Default: the repository’s default branch (usually master).
pathstring
Only commits containing this file path will be returned.
authorstring
GitHub login or email address by which to filter by commit author.
sincestring(date-time)
Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
untilstring(date-time)
Only commits before this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
Path Parameters
ownerstringrequired
repostringrequired
Response
application/json
Response
application/json
Response
Commit
urlstring(uri)required
Example:https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
shastringrequired
Example:6dcb09b5b57875f334f61aebed695e2e4193db5e
node_idstringrequired
Example:MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==
html_urlstring(uri)required
Example:https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e
comments_urlstring(uri)required
Example:https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments
commitobjectrequired
Show Child Parameters
authorobject | nullrequired
Simple User
Show Child Parameters
committerobject | nullrequired
Simple User
Show Child Parameters
parentsarray[object]required
Show Child Parameters
statsobject
Show Child Parameters
filesarray[object]
Diff Entry
Show Child Parameters
get/repos/{owner}/{repo}/commits
Path Parameters
Query Parameters
application/json
List branches for HEAD commit
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 GitHub’s products in the GitHub Help documentation.
Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch.
get
{protocol}://{hostname}/api/v3/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head
Path Parameters
ownerstringrequired
repostringrequired
commit_shastringrequired
commit_sha parameter
Response
application/json
Response
application/json
Response
Branch Short
namestringrequired
commitobjectrequired
Show Child Parameters
protectedbooleanrequired
get/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head
Path Parameters
application/json
List commit comments
Use the :commit_sha to specify the commit that will have its comments listed.
get
{protocol}://{hostname}/api/v3/repos/{owner}/{repo}/commits/{commit_sha}/comments
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
commit_shastringrequired
commit_sha parameter
Response
200 application/json
Response
200 application/json
Response
Commit Comment
html_urlstring(uri)required
urlstring(uri)required
idintegerrequired
node_idstringrequired
bodystringrequired
pathstring | nullrequired
positioninteger | nullrequired
lineinteger | nullrequired
commit_idstringrequired
userobject | nullrequired
Simple User
Show Child Parameters
created_atstring(date-time)required
updated_atstring(date-time)required
author_associationstringrequired
How the author is associated with the repository.
Allowed values:COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER
Example:OWNER
reactionsobject
Show Child Parameters
get/repos/{owner}/{repo}/commits/{commit_sha}/comments
Path Parameters
Query Parameters
200 application/json