Skip to main content
GitHub Docs
Version:
Enterprise Cloud
Search or ask Copilot
Search or ask
Copilot
Select language: current language is English
Search or ask Copilot
Search or ask
Copilot
Open menu
Open Sidebar
REST API
/
Pages
Home
REST API
API Version:
2022-11-28 (latest)
Quickstart
About the REST API
About the REST API
Comparing GitHub's APIs
API Versions
Breaking changes
OpenAPI description
Using the REST API
Getting started
Rate limits
Pagination
Libraries
Best practices
Troubleshooting
Timezones
CORS and JSONP
Issue event types
GitHub event types
Authentication
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
Guides
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
Actions
Artifacts
Cache
GitHub-hosted runners
OIDC
Permissions
Secrets
Self-hosted runner groups
Self-hosted runners
Variables
Workflow jobs
Workflow runs
Workflows
Activity
Events
Feeds
Notifications
Starring
Watching
Announcement banners
Enterprise
Organization
Apps
GitHub Apps
Installations
Marketplace
OAuth authorizations
Webhooks
Billing
Billing
Enhanced billing platform
Branches
Branches
Protected branches
Campaigns
Security campaigns
Checks
Check runs
Check suites
Classroom
Classroom
Code scanning
Alert dismissal requests
Code scanning
Code security settings
Configurations
Codes of conduct
Codes of conduct
Codespaces
Codespaces
Organizations
Organization secrets
Machines
Repository secrets
User secrets
Collaborators
Collaborators
Invitations
Commits
Commits
Commit comments
Commit statuses
Copilot
Copilot metrics
Copilot user management
Credentials
Revocation
Dependabot
Alerts
Repository access
Secrets
Dependency graph
Dependency review
Dependency submission
Software bill of materials (SBOM)
Deploy keys
Deploy keys
Deployments
Deployment branch policies
Deployments
Environments
Protection rules
Deployment statuses
Emojis
Emojis
Enterprise administration
Admin stats
Audit log
Billing
Bypass requests
Security features for code
Custom properties
License
Network configurations
GitHub App installations
Rules
SCIM
Gists
Gists
Comments
Git database
Blobs
Commits
References
Tags
Trees
Gitignore
Gitignore
Interactions
Organization
Repository
User
Issues
Assignees
Comments
Events
Issues
Issue dependencies
Labels
Milestones
Sub-issues
Timeline
Licenses
Licenses
Markdown
Markdown
Meta
Meta
Metrics
Community
Statistics
Traffic
Migrations
Organizations
Source endpoints
Users
Organizations
API Insights
Artifact attestations
Blocking users
Bypass requests
Custom properties
Custom roles
Issue types
Members
Network configurations
Organization roles
Organizations
Outside collaborators
Personal access tokens
Rule suites
Rules
Security managers
Webhooks
Packages
Packages
Pages
Pages
Private registries
Organization configurations
Projects (classic)
Cards
Collaborators
Columns
Boards
Pull requests
Pull requests
Review comments
Review requests
Reviews
Rate limit
Rate limit
Reactions
Reactions
Releases
Releases
Release assets
Repositories
Autolinks
Bypass requests
Contents
Custom properties
Forks
Git LFS
Repositories
Rule suites
Rules
Tags
Webhooks
SCIM
SCIM
Search
Search
Secret scanning
Alert dismissal requests
Push protection bypass
Push protection
Secret scanning
Security advisories
Global security advisories
Repository security advisories
Teams
Teams
Discussion comments
Discussions
External groups
Members
Team synchronization
Users
Attestations
Blocking users
Emails
Followers
GPG keys
Git SSH keys
Social accounts
SSH signing keys
Users
The REST API is now versioned.
For more information, see "
About API versioning
."
REST API
/
Pages
REST API endpoints for GitHub Pages
Use the REST API to interact with GitHub Pages sites and builds.
REST API endpoints for GitHub Pages
Get a GitHub Enterprise Cloud Pages site
Create a GitHub Enterprise Cloud Pages site
Update information about a GitHub Enterprise Cloud Pages site
Delete a GitHub Enterprise Cloud Pages site
List GitHub Enterprise Cloud Pages builds
Request a GitHub Enterprise Cloud Pages build
Get latest Pages build
Get GitHub Enterprise Cloud Pages build
Create a GitHub Pages deployment
Get the status of a GitHub Pages deployment
Cancel a GitHub Pages deployment
Get a DNS health check for GitHub Pages