Create a GitHub Enterprise Server Pages site

Configures a GitHub Enterprise Server Pages site. For more information, see "About GitHub Pages."

curl --location --request POST 'https://api.github.com/repos///pages' \ --header 'Content-Type: application/json' \ --data-raw '{ "source": { "branch": "main", "path": "/docs" } }'

{ "cname": "example.com", "custom_404": false, "html_url": "https://example.com", "https_certificate": { "description": "Certificate is approved", "domains": [ "example.com", "www.example.com" ], "expires_at": "2019-08-24", "state": "approved" }, "https_enforced": true, "public": true, "source": { "branch": "string", "path": "string" }, "status": "built", "url": "https://api.github.com/repos/github/hello-world/pages" }

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

owner

string

必需

repo

string

必需

Body 参数application/json

object | null

可选

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

source

object

必需

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

branch

string

必需

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

path

enum<string>

可选

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

枚举值:

//docs

默认值:

示例

返回响应

🟢201Response

application/json

Body

The configuration for GitHub Pages for a repository.

cname

string | null

必需

The Pages site's custom domain

示例值:

example.com

custom_404

boolean

必需

Whether the Page has a custom 404 page.

默认值:

false

示例值:

false

html_url

string <uri>

可选

The web address the Page can be accessed from.

示例值:

https://example.com

https_certificate

object (Pages Https Certificate)

可选

description

string

必需

示例值:

Certificate is approved

domains

array

必需

Array of the domain set and its alternate name (if it is configured)

示例值:

["example.com","www.example.com"]

expires_at

string <date>

可选

state

enum<string>

必需

枚举值:

newauthorization_createdauthorization_pendingauthorizedauthorization_revokedissueduploadedapprovederroredbad_authzdestroy_pendingdns_changed

示例值:

approved

https_enforced

boolean

可选

Whether https is enabled on the domain

示例值:

true

public

boolean

必需

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.

示例值:

true

source

object (Pages Source Hash)

可选

branch

string

必需

path

string

必需

status

enum<string> | enum<null>

必需

The status of the most recent build of the Page.

枚举值:

builtbuildingerrored

示例值:

built

url

string <uri>

必需

The API address for accessing this Page resource.

示例值:

https://api.github.com/repos/github/hello-world/pages

🟠409409

🟠415415

🟠422422