Skip to main content
Manja / GitHub
Schema1.1.4object

page

The configuration for GitHub Pages for a repository.

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

GitHub Pages

object

The configuration for GitHub Pages for a repository.

cname string
requirednullable

The Pages site's custom domain

Example:example.com

custom_404 boolean
required

Whether the Page has a custom 404 page.

Default:false

Example:false

html_url string (uri)
optional

The web address the Page can be accessed from.

Example:https://example.com

https_enforced boolean
optional

Whether https is enabled on the domain

Example:true

pending_domain_unverified_at string (date-time)
optionalnullable

The timestamp when a pending domain becomes unverified.

protected_domain_state string
optionalnullable

The state if the domain is verified

Example:pending

Allowed: "pending""verified""unverified"

public boolean
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.

Example:true

status string
requirednullable

The status of the most recent build of the Page.

Example:built

Allowed: "built""building""errored"

url string (uri)
required

The API address for accessing this Page resource.

Example:https://api.github.com/repos/github/hello-world/pages