页

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

Get a GitHub Enterprise Server Pages site

Gets information about a GitHub Enterprise Server Pages site.

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

“Get a GitHub Enterprise Server Pages site”的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.
路径参数
名称, 类型, 说明
`owner` string 必须 The account owner of the repository. The name is not case sensitive.
`repo` string 必须 The name of the repository. The name is not case sensitive.

“Get a GitHub Enterprise Server Pages site”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`404`	Resource not found

“Get a GitHub Enterprise Server Pages site”的示例代码

get/repos/{owner}/{repo}/pages

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pages

Response

Status: 200

{
  "url": "https://HOSTNAME/repos/github/developer.github.com/pages",
  "status": "built",
  "cname": "developer.github.com",
  "custom_404": false,
  "html_url": "https://developer.github.com",
  "source": {
    "branch": "master",
    "path": "/"
  },
  "public": true,
  "https_certificate": {
    "state": "approved",
    "description": "Certificate is approved",
    "domains": [
      "developer.github.com"
    ],
    "expires_at": "2021-05-22"
  },
  "https_enforced": true
}

Create a GitHub Enterprise Server Pages site

适用于 GitHub Apps

Configures a GitHub Enterprise Server 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.

“Create a GitHub Enterprise Server Pages site”的参数

标头

名称, 类型, 说明

accept string

Setting to application/vnd.github+json is recommended.

路径参数

名称, 类型, 说明

owner string 必须

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

repo string 必须

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

正文参数

名称, 类型, 说明

build_type string

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

可以是以下选项之一: legacy, workflow

source object

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

Properties of source

名称, 类型, 说明
`branch` string 必须 The repository branch used to publish your site's source files.
`path` string The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` 默认: `/` 可以是以下选项之一: `/`, `/docs`

“Create a GitHub Enterprise Server Pages site”的 HTTP 响应状态代码

状态代码	说明
`201`	Created
`409`	Conflict
`422`	Validation failed, or the endpoint has been spammed.

“Create a GitHub Enterprise Server Pages site”的示例代码

post/repos/{owner}/{repo}/pages

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pages \
  -d '{"source":{"branch":"main","path":"/docs"}}'

Response

Status: 201

{
  "url": "https://HOSTNAME/repos/github/developer.github.com/pages",
  "status": "built",
  "cname": "developer.github.com",
  "custom_404": false,
  "html_url": "https://developer.github.com",
  "source": {
    "branch": "master",
    "path": "/"
  },
  "public": true,
  "https_certificate": {
    "state": "approved",
    "description": "Certificate is approved",
    "domains": [
      "developer.github.com"
    ],
    "expires_at": "2021-05-22"
  },
  "https_enforced": true
}

Update information about a GitHub Enterprise Server Pages site

适用于 GitHub Apps

Updates information for a GitHub Enterprise Server 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 a GitHub Enterprise Server Pages site”的参数

标头

名称, 类型, 说明

accept string

Setting to application/vnd.github+json is recommended.

路径参数

名称, 类型, 说明

owner string 必须

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

repo string 必须

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

正文参数

名称, 类型, 说明

cname string or null

Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see "Using a custom domain with GitHub Pages."

https_enforced boolean

Specify whether HTTPS should be enforced for the repository.

build_type string

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

可以是以下选项之一: legacy, workflow

source object

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

Properties of source

名称, 类型, 说明
`branch` string 必须 The repository branch used to publish your site's source files.
`path` string 必须 The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. 可以是以下选项之一: `/`, `/docs`

“Update information about a GitHub Enterprise Server Pages site”的 HTTP 响应状态代码

状态代码	说明
`204`	No Content
`400`	Bad Request
`409`	Conflict
`422`	Validation failed, or the endpoint has been spammed.

“Update information about a GitHub Enterprise Server Pages site”的示例代码

put/repos/{owner}/{repo}/pages

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pages \
  -d '{"cname":"octocatblog.com","source":{"branch":"main","path":"/"}}'

Response

Status: 204

Delete a GitHub Enterprise Server Pages site

适用于 GitHub Apps

Deletes a GitHub Enterprise Server 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 a GitHub Enterprise Server Pages site”的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.
路径参数
名称, 类型, 说明
`owner` string 必须 The account owner of the repository. The name is not case sensitive.
`repo` string 必须 The name of the repository. The name is not case sensitive.

“Delete a GitHub Enterprise Server Pages site”的 HTTP 响应状态代码

状态代码	说明
`204`	No Content
`404`	Resource not found
`409`	Conflict
`422`	Validation failed, or the endpoint has been spammed.

“Delete a GitHub Enterprise Server Pages site”的示例代码

delete/repos/{owner}/{repo}/pages

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pages

Response

Status: 204

List GitHub Enterprise Server Pages builds

适用于 GitHub Apps

Lists builts of a GitHub Enterprise Server Pages site.

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

“List GitHub Enterprise Server Pages builds”的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.
路径参数
名称, 类型, 说明
`owner` string 必须 The account owner of the repository. The name is not case sensitive.
`repo` string 必须 The name of the repository. The name is not case sensitive.
查询参数
名称, 类型, 说明
`per_page` integer The number of results per page (max 100). 默认: `30`
`page` integer Page number of the results to fetch. 默认: `1`

“List GitHub Enterprise Server Pages builds”的 HTTP 响应状态代码

状态代码	说明
`200`	OK

“List GitHub Enterprise Server Pages builds”的示例代码

get/repos/{owner}/{repo}/pages/builds

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pages/builds

Response

Status: 200

[
  {
    "url": "https://HOSTNAME/repos/github/developer.github.com/pages/builds/5472601",
    "status": "built",
    "error": {
      "message": null
    },
    "pusher": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://HOSTNAME/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://HOSTNAME/users/octocat/followers",
      "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
      "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
      "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
      "organizations_url": "https://HOSTNAME/users/octocat/orgs",
      "repos_url": "https://HOSTNAME/users/octocat/repos",
      "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
      "received_events_url": "https://HOSTNAME/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "commit": "351391cdcb88ffae71ec3028c91f375a8036a26b",
    "duration": 2104,
    "created_at": "2014-02-10T19:00:49Z",
    "updated_at": "2014-02-10T19:00:51Z"
  }
]

Request a GitHub Enterprise Server Pages build

适用于 GitHub Apps

You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.

Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.

“Request a GitHub Enterprise Server Pages build”的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.
路径参数
名称, 类型, 说明
`owner` string 必须 The account owner of the repository. The name is not case sensitive.
`repo` string 必须 The name of the repository. The name is not case sensitive.

“Request a GitHub Enterprise Server Pages build”的 HTTP 响应状态代码

状态代码	说明
`201`	Created

“Request a GitHub Enterprise Server Pages build”的示例代码

post/repos/{owner}/{repo}/pages/builds

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pages/builds

Response

Status: 201

{
  "url": "https://HOSTNAME/repos/github/developer.github.com/pages/builds/latest",
  "status": "queued"
}

Get latest Pages build

适用于 GitHub Apps

Gets information about the single most recent build of a GitHub Enterprise Server Pages site.

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

“Get latest Pages build”的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.
路径参数
名称, 类型, 说明
`owner` string 必须 The account owner of the repository. The name is not case sensitive.
`repo` string 必须 The name of the repository. The name is not case sensitive.

“Get latest Pages build”的 HTTP 响应状态代码

状态代码	说明
`200`	OK

“Get latest Pages build”的示例代码

get/repos/{owner}/{repo}/pages/builds/latest

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pages/builds/latest

Response

Status: 200

{
  "url": "https://HOSTNAME/repos/github/developer.github.com/pages/builds/5472601",
  "status": "built",
  "error": {
    "message": null
  },
  "pusher": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://HOSTNAME/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://HOSTNAME/users/octocat/followers",
    "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
    "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
    "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
    "organizations_url": "https://HOSTNAME/users/octocat/orgs",
    "repos_url": "https://HOSTNAME/users/octocat/repos",
    "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
    "received_events_url": "https://HOSTNAME/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  "commit": "351391cdcb88ffae71ec3028c91f375a8036a26b",
  "duration": 2104,
  "created_at": "2014-02-10T19:00:49Z",
  "updated_at": "2014-02-10T19:00:51Z"
}

Get GitHub Enterprise Server Pages build

适用于 GitHub Apps

Gets information about a GitHub Enterprise Server Pages build.

A token with the repo scope is required. GitHub Apps must have the pages:read permission.

“Get GitHub Enterprise Server Pages build”的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.
路径参数
名称, 类型, 说明
`owner` string 必须 The account owner of the repository. The name is not case sensitive.
`repo` string 必须 The name of the repository. The name is not case sensitive.
`build_id` integer 必须

“Get GitHub Enterprise Server Pages build”的 HTTP 响应状态代码

状态代码	说明
`200`	OK

“Get GitHub Enterprise Server Pages build”的示例代码

get/repos/{owner}/{repo}/pages/builds/{build_id}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pages/builds/BUILD_ID

Response

Status: 200

{
  "url": "https://HOSTNAME/repos/github/developer.github.com/pages/builds/5472601",
  "status": "built",
  "error": {
    "message": null
  },
  "pusher": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://HOSTNAME/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://HOSTNAME/users/octocat/followers",
    "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
    "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
    "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
    "organizations_url": "https://HOSTNAME/users/octocat/orgs",
    "repos_url": "https://HOSTNAME/users/octocat/repos",
    "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
    "received_events_url": "https://HOSTNAME/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  "commit": "351391cdcb88ffae71ec3028c91f375a8036a26b",
  "duration": 2104,
  "created_at": "2014-02-10T19:00:49Z",
  "updated_at": "2014-02-10T19:00:51Z"
}