ownerstringrequired
repostringrequired
Request a GitHub Enterprise Server Pages build
You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
post
http://HOSTNAME/api/v3/repos/{owner}/{repo}/pages/builds
Path Parameters
Response
201 application/json
Response
201 application/json
Response
Page Build Status
Page Build Status
urlstring(uri)required
Example:https://api.github.com/repos/github/hello-world/pages/builds/latest
statusstringrequired
Example:queued
post/repos/{owner}/{repo}/pages/builds
Path Parameters
201 application/json
Get latest Pages build
get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/pages/builds/latest
Path Parameters
ownerstringrequired
repostringrequired
Response
200 application/json
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
Path Parameters
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
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}
Path Parameters
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
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
Path Parameters
Query Parameters
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
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}
Path Parameters
Query Parameters
application/json