Schema1.1.4object

page

The configuration for GitHub Pages for a repository.

Source: github-v3-rest.json
Revision: f5f067c1e6f6
Active snapshot: 85e53e3d0d65

Pages Source Hash

object

branch string

required

path string

required

Root JSON Schema

{"description":"The configuration for GitHub Pages for a repository.","properties":{"cname":{"description":"The Pages site's custom domain","example":"example.com","nullable":true,"type":"string"},"custom_404":{"default":false,"description":"Whether the Page has a custom 404 page.","example":false,"type":"boolean"},"html_url":{"description":"The web address the Page can be accessed from.","example":"https://example.com","format":"uri","type":"string"},"https_certificate":{"$ref":"#/components/schemas/pages-https-certificate"},"https_enforced":{"description":"Whether https is enabled on the domain","example":true,"type":"boolean"},"pending_domain_unverified_at":{"description":"The timestamp when a pending domain becomes unverified.","format":"date-time","nullable":true,"type":"string"},"protected_domain_state":{"description":"The state if the domain is verified","enum":["pending","verified","unverified"],"example":"pending","nullable":true,"type":"string"},"public":{"description":"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.","example":true,"type":"boolean"},"source":{"$ref":"#/components/schemas/pages-source-hash"},"status":{"description":"The status of the most recent build of the Page.","enum":["built","building","errored"],"example":"built","nullable":true,"type":"string"},"url":{"description":"The API address for accessing this Page resource.","example":"https://api.github.com/repos/github/hello-world/pages","format":"uri","type":"string"}},"required":["url","status","cname","custom_404","public"],"title":"GitHub Pages","type":"object"}