Search
K
GitHub v3 REST API

Get latest Pages build

get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/pages/builds/latest

Path Parameters

ownerstringrequired
repostringrequired

Response

200 application/json

Response

Page Build

Page Build

urlstring(uri)required
statusstringrequired
errorobjectrequired
Show Child Parameters
pusherobject | nullrequired

Simple User

Show Child Parameters
commitstringrequired
durationintegerrequired
created_atstring(date-time)required
updated_atstring(date-time)required
get/repos/{owner}/{repo}/pages/builds/latest
 
200 application/json

Get GitHub Enterprise Server Pages build

get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/pages/builds/{build_id}

Path Parameters

ownerstringrequired
repostringrequired
build_idintegerrequired

Response

200 application/json

Response

Page Build

Page Build

urlstring(uri)required
statusstringrequired
errorobjectrequired
Show Child Parameters
pusherobject | nullrequired

Simple User

Show Child Parameters
commitstringrequired
durationintegerrequired
created_atstring(date-time)required
updated_atstring(date-time)required
get/repos/{owner}/{repo}/pages/builds/{build_id}
 
200 application/json

Get a repository README

Gets the preferred README for a repository.

READMEs support custom media types for retrieving the raw content or rendered HTML.

get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/readme

Query Parameters

refstring

The name of the commit/branch/tag. Default: the repository’s default branch (usually master)

Path Parameters

ownerstringrequired
repostringrequired

Response

application/json

Response

Content File

Content File

typestringrequired
encodingstringrequired
sizeintegerrequired
namestringrequired
pathstringrequired
contentstringrequired
shastringrequired
urlstring(uri)required
git_urlstring | null(uri)required
html_urlstring | null(uri)required
download_urlstring | null(uri)required
_linksobjectrequired
Show Child Parameters
targetstring

Example:"actual/actual.md"

submodule_git_urlstring

Example:"git://example.com/defunkt/dotjs.git"

get/repos/{owner}/{repo}/readme
 
application/json

Get a repository README for a directory

Gets the README from a repository directory.

READMEs support custom media types for retrieving the raw content or rendered HTML.

get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/readme/{dir}

Query Parameters

refstring

The name of the commit/branch/tag. Default: the repository’s default branch (usually master)

Path Parameters

ownerstringrequired
repostringrequired
dirstringrequired

The alternate path to look for a README file

Response

application/json

Response

Content File

Content File

typestringrequired
encodingstringrequired
sizeintegerrequired
namestringrequired
pathstringrequired
contentstringrequired
shastringrequired
urlstring(uri)required
git_urlstring | null(uri)required
html_urlstring | null(uri)required
download_urlstring | null(uri)required
_linksobjectrequired
Show Child Parameters
targetstring

Example:"actual/actual.md"

submodule_git_urlstring

Example:"git://example.com/defunkt/dotjs.git"

get/repos/{owner}/{repo}/readme/{dir}
 
application/json

List releases

This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the Repository Tags API.

Information about published releases are available to everyone. Only users with push access will receive listings for draft releases.

get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/releases

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

Response

application/json

Response

A release.

urlstring(uri)required
html_urlstring(uri)required
assets_urlstring(uri)required
upload_urlstringrequired
tarball_urlstring | null(uri)required
zipball_urlstring | null(uri)required
idintegerrequired
node_idstringrequired
tag_namestringrequired

The name of the tag.

Example:v1.0.0

target_commitishstringrequired

Specifies the commitish value that determines where the Git tag is created from.

Example:master

namestring | nullrequired
bodystring | null
draftbooleanrequired

true to create a draft (unpublished) release, false to create a published one.

Example:false

prereleasebooleanrequired

Whether to identify the release as a prerelease or a full release.

Example:false

created_atstring(date-time)required
published_atstring | null(date-time)required
authorobjectrequired

Simple User

Show Child Parameters
assetsarray[object]required

Data related to a release.

Show Child Parameters
body_htmlstring
body_textstring
reactionsobject
Show Child Parameters
get/repos/{owner}/{repo}/releases
 
application/json