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

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

The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

Servers

Path parameters

Name Type Required Description
repo String Yes

The name of the repository without the .git extension. The name is not case sensitive.

owner String Yes

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

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
source Object No

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

source.branch String Yes

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

source.path String No

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

Possible values:

  • "/"
  • "/docs"

Default value: "/"

build_type String No

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

Possible values:

  • "workflow"
  • "legacy"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.