Hanzo
OpenapiIntegrations

Creates the repo's Pages site and answers 201 Created with it.

Creates the repo's Pages site and answers 201 Created with it.

POST /v1/integrations/github/repos/{repo}/pages

Addresshttps://api.hanzo.ai/v1/integrations/github/repos/{repo}/pages
MethodPOST
Operationpost_integrations_github_repos_by_repo_pages
AuthAuthorization: Bearer $HANZO_API_KEY

Creates the repo's Pages site and answers 201 Created with it. With buildType "workflow" the site builds via GitHub Actions; otherwise it builds from a branch source, defaulting to the repo's own default branch when none is given. Only "/" and "/docs" are legal source paths (GitHub's rule).

Request

5 fields, body application/json (required).

FieldInTypeRequiredDescription
repopathstringyesRepo is the repository, from the :repo path segment.
branchbodystringBranch is the legacy source branch; empty defaults to the repo's own default branch.
buildTypebodystringBuildType selects the builder: "workflow" builds via GitHub Actions, anything else builds from the branch source above.
pathbodystringPath is the source directory within the branch: "/" (the default) or "/docs".
repobodystringRepo is the repository, from the :repo path segment.

Response

StatusBodyMeaning
200githubPagesViewok

200 body — 10 fields.

FieldInTypeAlwaysDescription
buildTypebodystringBuildType is the builder in use: "legacy" (branch source) or "workflow".
cnamebodystringCNAME is the custom domain, absent when none is set.
custom404bodybooleanCustom404 is whether the repo ships its own 404 page.
httpsEnforcedbodybooleanHTTPSEnforced is GitHub's enforce-HTTPS bit.
repobodystringRepo is the repository the site belongs to.
sourcebodygithubPagesSource
source.branchbodystringBranch is the branch the site builds from.
source.pathbodystringPath is the directory within that branch: "/" or "/docs".
statusbodystringStatus is GitHub's build state: "built", "building" or "errored".
urlbodystringURL is the live site (GitHub's html_url).

Failure carries the platform error shape — see Errors.

Examples

hanzo integrations github repos pages create <repo>

Integrations API · All Hanzo APIs · Interactive reference

How is this guide?

On this page