Update information about a GitHub Pages site

PUT

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

Updates information for a GitHub 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.

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

204 - Example 1

{}

Request

Path Params

owner

string

required

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

repo

string

required

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

Body Params application/json

optional

build_type

enum<string>

required

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.

Allowed values:

legacyworkflow

cname

string | null

optional

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

optional

Specify whether HTTPS should be enforced for the repository.

source

optional

Examples

Responses

🟢204Response

application/json

Body

object {0}

🟠400400

🟠409409

🟠422422

Modified at 2023-08-15 02:59:29

Create a GitHub Pages site

List GitHub Pages builds