Sample - GitHub REST API
GET/repos/{owner}/{repo}/pages/builds/{build_id}

Get a GitHub Pages build

Retrieves information about a GitHub Pages build for a repository. Provide the repository owner and repo together with the integer build_id; OAuth app tokens and classic personal access tokens require the repo scope.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

3 parameters
ownerstringrequired
The account owner of the repository; the name is not case sensitive.
repostringrequired
The repository name without the `.git` extension; the name is not case sensitive.
build_idintegerrequired
The integer identifier of the GitHub Pages build to retrieve.

1 status code
200Returns a GitHub Pages build object containing its URL, status, error details, pusher, commit, duration, and creation and update timestamps.
urlstringrequired
statusstringrequired
errorobjectrequired
pusherobjectrequired
A GitHub user.
commitstringrequired
durationintegerrequired
created_atstringrequired
updated_atstringrequired

Error handling

Use an OAuth app token or classic personal access token with the repo scope when required. owner and repo must identify the repository, and build_id must be an integer identifying the Pages build to retrieve.