REST API endpoints for GitHub Pages

Enterprise Cloud

Enterprise Server 3.10

Enterprise Server 3.11

Enterprise Server 3.12

Enterprise Server 3.13

Enterprise Server 3.14

Enterprise Server 3.15

Free, Pro, & Team

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!

Domain name

Who can use this feature?

Actions

Multiple permissions are required, or a different permission may be used. For more information about the permissions, see the documentation for this endpoint.

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

REST API endpoints for GitHub Pages - GitHub Docs

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

Quickstart

About the REST API

Comparing GitHub's APIs

API Versions

Breaking changes

OpenAPI description

Getting started

Rate limits

Pagination

Libraries

Best practices

Troubleshooting

Timezones

CORS and JSONP

Issue event types

GitHub event types

Using the REST API

Authenticating

Keeping API credentials secure

Endpoints for GitHub App installation tokens

Endpoints for GitHub App user tokens

Endpoints for fine-grained PATs

Permissions for GitHub Apps

Permissions for fine-grained PATs

Authentication

Script with JavaScript

Script with Ruby

Discover resources for a user

Delivering deployments

Rendering data as graphs

Working with comments

Building a CI server

Get started - Git database

Get started - Checks

Encrypt secrets

Guides

Artifacts

Cache

OIDC

Permissions

Secrets

Self-hosted runner groups

Self-hosted runners

Variables

Workflow jobs

Workflow runs

Workflows

Events

Feeds

Notifications

Starring

Watching

Activity

GitHub Apps

Installations

Marketplace

OAuth authorizations

Webhooks

Apps

Billing

Enhanced billing platform

Branches

Protected branches

Check runs

Check suites

Checks

Classroom

Code scanning

Configurations

Code security settings

Codes of conduct

Codespaces

Organizations

Organization secrets

Machines

Repository secrets

User secrets

Collaborators

Invitations

Commits

Commit comments

Commit statuses

Copilot metrics

Copilot usage

Copilot user management

Copilot

Alerts

Dependabot

Dependency review

Dependency submission

Software bill of materials (SBOM)

Dependency graph

Deploy keys

Deployment branch policies

Deployments

Environments

Protection rules

Deployment statuses

Emojis

Gists

Comments

Blobs

References

Trees

Git database

Gitignore

Organization

Repository

User

Interactions

Issues

Assignees

Labels

Milestones

Timeline

Licenses

Markdown

Community

Statistics

Traffic

Metrics

Source endpoints

Users

Migrations

API Insights

Blocking users

Custom properties

Members

Organization roles

Outside collaborators

Personal access tokens

Rule suites

Rules

Security managers

Packages

Pages

Boards

Cards

Columns

Projects (classic)

Pull requests

Review comments

Review requests

Reviews

Rate limit

Reactions

Releases

Release assets

Autolinks

Forks

Repositories

Search

Secret scanning

Global security advisories

Repository security advisories

Security advisories

Teams

Discussion comments

Discussions

Attestations

Emails

Followers

GPG keys

Git SSH keys

Social accounts

SSH signing keys

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 Pages site.
OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.

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

owner

Get a GitHub Pages site