Enterprise Cloud

Enterprise Server

Enterprise Server 3.10

Enterprise Server 3.6

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

REST API

所有 GitHub 文档都是开源的。 看到错误或不清楚的内容了吗？ 提交拉取请求。

帮助我们创建出色的文档！

在 GitHub 旅程中随时为你提供帮助。

可以是以下选项之一

名称

所有 {{ name }} 指南

{{ name }} 学习路径

操作

输入搜索词以在 GitHub 文档中找到它。

页 - GitHub Enterprise Server 3.7 Docs

使用 REST API 与 GitHub Pages 站点和生成进行交互。

English

Simplified Chinese

Spanish

Portuguese

Russian

Japanese

French

German

Korean

快速入门

关于 GitHub 的 API

REST API 中的资源

媒体类型

身份验证

确保 API 凭据安全

故障排除

OpenAPI 描述

议题事件类型

GitHub 事件类型

适用于 GitHub Apps 安装令牌的终结点

适用于 GitHub Apps 用户令牌的终结点

GitHub 应用的权限

概述

使用 API

使用 JavaScript 编写脚本

为用户发现资源

交付部署

将数据渲染为图形

处理注释

分页

构建 CI 服务器

最佳实践

入门 - Git 数据库

开始 - 检查

加密机密

Guides

Artifacts

缓存

OIDC

权限

机密

自托管运行器组

自托管运行程序

工作流程作业

工作流运行

工作流

事件

通知

标星

关注中

活动

GitHub 应用

安装

OAuth 授权

Webhook

应用

计费

分支

受保护的分支

检查运行

检查套件

检查

行为准则

代码扫描

协作者

邀请

提交

提交注释

提交状态

Dependabot

依赖项检查

依赖项提交

依赖项关系图

部署密钥

部署分支策略

部署

环境

部署状态

表情符号

管理统计

公告

审核日志

全局 Webhook

LDAP

许可证

管理控制台

组织预接收挂钩

组织

预接收环境

预接收挂钩

存储库预接收挂钩

SCIM

用户

企业管理

Gists

注释

Blob

reference

标记

Trees

Git 数据库

Gitignore

问题

受理人

里程碑

时间线

Markdown

元数据

统计信息

指标

迁移

自定义存储库角色

成员

外部协作者

安全经理

Boards

卡片

Project boards

拉取

评价注释

审查请求

审阅

速率限制

反应

发行版本

发布资产

自动链接

前叉

Git LFS

存储库

搜索

机密扫描

Teams

讨论评论

讨论

外部组

电子邮件

关注者

GPG 密钥

Git SSH 密钥

SSH 签名密钥

存储库 Webhook 配置

存储库 Webhook 交付

存储库 Webhook

仓库 web 挂钩

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.7/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