Get a GitHub Pages site | Sample

2 parameters

ownerstringrequired

The account owner of the repository. The name is not case sensitive.

repostringrequired

The name of the repository without the `.git` extension. The name is not case sensitive.

2 status codes

200Response

urlstringrequired

The API address for accessing this Page resource.

statusstringrequired

The status of the most recent build of the Page.

Allowed:builtbuildingerrored

cnamestringrequired

The Pages site's custom domain

protected_domain_statestringoptional

The state if the domain is verified

Allowed:pendingverifiedunverified

pending_domain_unverified_atstringoptional

The timestamp when a pending domain becomes unverified.

custom_404booleanrequired

Whether the Page has a custom 404 page.

Default:false

html_urlstringoptional

The web address the Page can be accessed from.

build_typestringoptional

The process in which the Page will be built.

Allowed:legacyworkflow

sourceobjectoptional

publicbooleanrequired

Whether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site.

https_certificateobjectoptional

https_enforcedbooleanoptional

Whether https is enabled on the domain

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 404 is returned: Resource not found.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.pages.list({
  owner: "octocat",
  repo: "hello-world",
});

{
  "url": "https://api.github.com/repos/github/developer.github.com/pages",
  "status": "built",
  "cname": "developer.github.com",
  "custom_404": false,
  "html_url": "https://developer.github.com",
  "source": {
    "branch": "master",
    "path": "/"
  },
  "public": true,
  "pending_domain_unverified_at": "2024-04-30T19:33:31Z",
  "protected_domain_state": "verified",
  "https_certificate": {
    "state": "approved",
    "description": "Certificate is approved",
    "domains": [
      "developer.github.com"
    ],
    "expires_at": "2021-05-22"
  },
  "https_enforced": true
}

Request

Response

Errors