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

Body Params application/json

Examples

Responses

🟢204Response

application/json

Body

🟠400400

🟠409409

🟠422422

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

Create a GitHub Pages site

List GitHub Pages builds