Get a GitHub Pages build | GitHub API (unofficial showcase)

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 the GitHub Pages build object, including 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

The owner and repo path parameters must identify the repository containing the build, and the build_id path parameter must be an integer identifying the build.

import { Client } from "@octridev/github";

const client = new Client({
  baseUrl: "https://api.github.com",
});

const result = await client.builds.get({
  owner: "octocat",
  repo: "hello-world",
  buildId: "c0a80123-4567-89ab-cdef-0123456789ab",
});

{
  "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601",
  "status": "built",
  "error": {
    "message": null
  },
  "pusher": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  "commit": "351391cdcb88ffae71ec3028c91f375a8036a26b",
  "duration": 2104,
  "created_at": "2014-02-10T19:00:49Z",
  "updated_at": "2014-02-10T19:00:51Z"
}

Request

Response

Errors