Skip to main content

pages

Overview

Namepages
TypeResource
Idgithub.repos.pages

Fields

NameDatatypeDescription
https_enforcedbooleanWhether https is enabled on the domain
statusstringThe status of the most recent build of the Page.
publicbooleanWhether 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.
sourceobject
https_certificateobject
pending_domain_unverified_atstringThe timestamp when a pending domain becomes unverified.
cnamestringThe Pages site's custom domain
urlstringThe API address for accessing this Page resource.
html_urlstringThe web address the Page can be accessed from.
protected_domain_statestringThe state if the domain is verified
custom_404booleanWhether the Page has a custom 404 page.

Methods

NameAccessible byRequired ParamsDescription
get_pagesSELECTowner, repo
create_pages_siteINSERTowner, repo, data__sourceConfigures a GitHub Pages site. For more information, see "About GitHub Pages."
delete_pages_siteDELETEowner, repo
update_information_about_pages_siteEXECowner, repoUpdates information for a GitHub Pages site. For more information, see "About GitHub Pages.