pages

Overview

Name	pages
Type	Resource
Id	github.repos.pages

Fields

Name	Datatype	Description
build_type	string	The process in which the Page will be built.
cname	string	The Pages site's custom domain
custom_404	boolean	Whether the Page has a custom 404 page.
html_url	string	The web address the Page can be accessed from.
https_certificate	object
https_enforced	boolean	Whether https is enabled on the domain
pending_domain_unverified_at	string	The timestamp when a pending domain becomes unverified.
protected_domain_state	string	The state if the domain is verified
public	boolean	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.
source	object
status	string	The status of the most recent build of the Page.
url	string	The API address for accessing this Page resource.

Methods

Name	Accessible by	Required Params	Description
get_pages	SELECT	owner, repo	Gets information about a GitHub Pages site. A token with the repo scope is required. GitHub Apps must have the pages:read permission.
create_pages_site	INSERT	owner, repo	Configures a GitHub Pages site. For more information, see "About GitHub Pages." To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the repo scope or Pages write permission is required. GitHub Apps must have the administration:write and pages:write permissions.
delete_pages_site	DELETE	owner, repo	Deletes a GitHub Pages site. For more information, see "About GitHub Pages. To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the repo scope or Pages write permission is required. GitHub Apps must have the administration:write and pages:write permissions.
update_information_about_pages_site	EXEC	owner, repo	Updates information for a GitHub Pages site. For more information, see "About GitHub Pages. To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the repo scope or Pages write permission is required. GitHub Apps must have the administration:write and pages:write permissions.