Pages

Enterprise Cloud

Enterprise Server

Enterprise Server 3.5

Enterprise Server 3.6

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

REST API

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Help us make these docs great!

Help for wherever you are on your GitHub journey.

Can be one of

Name

All {{ name }} guides

{{ name }} learning paths

Actions

GitHub began rolling these changes out to enterprises on

Enter a search term to find it in the GitHub Docs.

Pages - GitHub Enterprise Server 3.5 Docs

Use the REST API to interact with GitHub Pages sites and builds.

English

Simplified Chinese

Spanish

Portuguese

Russian

Japanese

French

German

Korean

Quickstart

About GitHub's APIs

Resources in the REST API

Media types

Authenticating

Keeping API credentials secure

Troubleshooting

Libraries

OpenAPI description

Endpoints for GitHub App installation tokens

Endpoints for GitHub App user tokens

Permissions for GitHub Apps

Overview

Using the API

Script with JavaScript

Discover resources for a user

Delivering deployments

Rendering data as graphs

Working with comments

Pagination

Building a CI server

Integrator best practices

Get started - Git database

Get started - Checks

Guides

Artifacts

Cache

Permissions

Secrets

Self-hosted runner groups

Self-hosted runners

Workflow jobs

Workflow runs

Workflows

Events

Feeds

Notifications

Starring

Watching

Activity

GitHub Apps

Installations

OAuth Authorizations

Webhooks

Apps

Billing

Branches

Protected branches

Check Runs

Check Suites

Checks

Codes of conduct

Code Scanning

Collaborators

Invitations

Commits

Commit comments

Commit statuses

Dependabot

Deploy keys

Deployment branch policies

Deployments

Environments

Deployment statuses

Emojis

Admin stats

Announcement

Audit log

Global Webhooks

LDAP

License

Management Console

Organization Pre-receive Hooks

Organizations

Pre-receive Environments

Pre-receive Hooks

Repository Pre-receive Hooks

Users

Enterprise administration

Gists

Comments

Blobs

References

Trees

Git database

Gitignore

Issues

Assignees

Labels

Milestones

Timeline

Licenses

Markdown

Statistics

Metrics

Migrations

OAuth authorizations

Custom Repository Roles

Members

Outside Collaborators

Boards

Cards

Columns

Project boards

Pulls

Review comments

Review requests

Reviews

Rate limit

Reactions

Releases

Release Assets

Autolinks

Forks

Git LFS

Repositories

Search

Secret scanning

Teams

Discussion comments

Discussions

Emails

Followers

GPG Keys

Git SSH Keys

Repository Webhook Configuration

Repository Webhook Deliveries

Repository Webhooks

Repository webhooks

The configuration for GitHub Pages for a repository.

The process in which the Page will be built.

The web address the Page can be accessed from.

Pages Https Certificate

The timestamp when a pending domain becomes unverified.

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.

Pages Source Hash

The status of the most recent build of the Page.

The API address for accessing this Page resource.

GitHub Pages

Gets information about a GitHub Enterprise Server Pages site.
A token with the <code>repo</code> scope is required. GitHub Apps must have the <code>pages:read</code> permission.

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

owner

The name of the repository without the <code>.git</code> extension. The name is not case sensitive.

repo

Get a GitHub Enterprise Server Pages site

The process in which the Page will be built. Possible values are <code>"legacy"</code> and <code>"workflow"</code>.

build_type

The repository branch used to publish your site's source files.

branch

The repository directory that includes the source files for the Pages site. Allowed paths are <code>/</code> or <code>/docs</code>. Default: <code>/</code>

path

The source branch and directory used to publish your Pages site.

source

Configures a GitHub Enterprise Server Pages site. For more information, see "<a href="/github/working-with-github-pages/about-github-pages">About GitHub Pages</a>."
To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the <code>repo</code> scope or Pages write permission is required. GitHub Apps must have the <code>administration:write</code> and <code>pages:write</code> permissions.

Validation failed, or the endpoint has been spammed.

Create a GitHub Enterprise Server Pages site

Specify a custom domain for the repository. Sending a <code>null</code> value will remove the custom domain. For more about custom domains, see "<a href="https://docs.github.com/enterprise-server@3.5/articles/using-a-custom-domain-with-github-pages/">Using a custom domain with GitHub Pages</a>."

cname

Specify whether HTTPS should be enforced for the repository.

https_enforced

The process by which the GitHub Pages site will be built. <code>workflow</code> means that the site is built by a custom GitHub Actions workflow. <code>legacy</code> means that the site is built by GitHub when changes are pushed to a specific branch.

The repository directory that includes the source files for the Pages site. Allowed paths are <code>/</code> or <code>/docs</code>.

Update the source for the repository. Must include the branch name and path.

Updates information for a GitHub Enterprise Server Pages site. For more information, see "<a href="/github/working-with-github-pages/about-github-pages">About GitHub Pages</a>.
To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the <code>repo</code> scope or Pages write permission is required. GitHub Apps must have the <code>administration:write</code> and <code>pages:write</code> permissions.

Update information about a GitHub Enterprise Server Pages site

Deletes a GitHub Enterprise Server Pages site. For more information, see "<a href="/github/working-with-github-pages/about-github-pages">About GitHub Pages</a>.
To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the <code>repo</code> scope or Pages write permission is required. GitHub Apps must have the <code>administration:write</code> and <code>pages:write</code> permissions.

Delete a GitHub Enterprise Server Pages site