GitHub v3 REST API

List gist commits

get
http://HOSTNAME/api/v3/gists/{gist_id}/commits

Query Parameters

per_pageinteger

Results per page (max 100)

Default:30

pageinteger

Page number of the results to fetch.

Default:1

Path Parameters

gist_idstringrequired

gist_id parameter

Response

application/json

Response

Gist Commit

urlstring(uri)required

Example:https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f

versionstringrequired

Example:57a7f021a713b1c5a6a199b54cc514735d2d462f

userobject | nullrequired

Simple User

Show Child Parameters
change_statusobjectrequired
Show Child Parameters
committed_atstring(date-time)required

Example:2010-04-14T02:15:15Z

get/gists/{gist_id}/commits
 
application/json

List gist forks

get
http://HOSTNAME/api/v3/gists/{gist_id}/forks

Query Parameters

per_pageinteger

Results per page (max 100)

Default:30

pageinteger

Page number of the results to fetch.

Default:1

Path Parameters

gist_idstringrequired

gist_id parameter

Response

application/json

Response

Gist Simple

forksarray | null[object]DEPRECATED
Show Child Parameters
historyarray | null[object]DEPRECATED

Gist History

Show Child Parameters
fork_ofobject | null

Gist

Show Child Parameters
urlstring
forks_urlstring
commits_urlstring
idstring
node_idstring
git_pull_urlstring
git_push_urlstring
html_urlstring
filesobject
publicboolean
created_atstring
updated_atstring
descriptionstring | null
commentsinteger
userstring | null
comments_urlstring
ownerobject

Simple User

Show Child Parameters
truncatedboolean
get/gists/{gist_id}/forks
 
application/json

Fork a gist

Note: This was previously /gists/:gist_id/fork.

post
http://HOSTNAME/api/v3/gists/{gist_id}/forks

Path Parameters

gist_idstringrequired

gist_id parameter

Response

application/json

Response

Base Gist

Base Gist

urlstring(uri)required
forks_urlstring(uri)required
commits_urlstring(uri)required
idstringrequired
node_idstringrequired
git_pull_urlstring(uri)required
git_push_urlstring(uri)required
html_urlstring(uri)required
filesobjectrequired
publicbooleanrequired
created_atstring(date-time)required
updated_atstring(date-time)required
descriptionstring | nullrequired
commentsintegerrequired
userobject | nullrequired

Simple User

Show Child Parameters
comments_urlstring(uri)required
ownerobject

Simple User

Show Child Parameters
truncatedboolean
forksarray
historyarray
post/gists/{gist_id}/forks
 
application/json

Check if a gist is starred

get
http://HOSTNAME/api/v3/gists/{gist_id}/star

Path Parameters

gist_idstringrequired

gist_id parameter

Response

Response if gist is starred

get/gists/{gist_id}/star
 

Star a gist

Note that you’ll need to set Content-Length to zero when calling out to this endpoint. For more information, see “HTTP verbs.”

put
http://HOSTNAME/api/v3/gists/{gist_id}/star

Path Parameters

gist_idstringrequired

gist_id parameter

Response

Response

put/gists/{gist_id}/star