v50

latestOpenAPI 3.0.3MITraw.githubusercontent.com2023-11-288093493.9 MB

repos

Get a GitHub Enterprise Server Pages site

Gets information about a GitHub Enterprise Server Pages site.

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

get/repos/{owner}/{repo}/pages

Path parameters

ownerstring required

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

repostring required

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

Response

urlstring uri required

The API address for accessing this Page resource.

status'built' | 'building' | 'errored' nullable required

The status of the most recent build of the Page.

cnamestring nullable required

The Pages site's custom domain

protected_domain_state'pending' | 'verified' | 'unverified' nullable

The state if the domain is verified

pending_domain_unverified_atstring date-time nullable

The timestamp when a pending domain becomes unverified.

custom_404boolean required

Whether the Page has a custom 404 page.

html_urlstring uri

The web address the Page can be accessed from.

build_type'legacy' | 'workflow' nullable

The process in which the Page will be built.

publicboolean required

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_enforcedboolean

Whether https is enabled on the domain

Example response

{
  "url": "https://api.github.com/repos/github/hello-world/pages",
  "status": "built",
  "cname": "example.com",
  "protected_domain_state": "pending",
  "html_url": "https://example.com",
  "build_type": "legacy",
  "public": true,
  "https_certificate": {
    "state": "approved",
    "description": "Certificate is approved",
    "domains": [
      "example.com",
      "www.example.com"
    ]
  },
  "https_enforced": true
}