Hanzo
OpenapiIntegrations

Returns the repo's Pages status, live URL, custom domain and build source.

Returns the repo's Pages status, live URL, custom domain and build source.

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

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

Returns the repo's Pages status, live URL, custom domain and build source. The repo is resolved against the org installation's GRANTED set, so a caller can never address a repo the App was not granted; 404 when the repo has no Pages site.

Request

1 field.

FieldInTypeRequiredDescription
repopathstringyesRepo is the repository's short name within the org's installation, with no owner prefix (the owner is server-derived from the grant).

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 get <repo>

Integrations API · All Hanzo APIs · Interactive reference

How is this guide?

On this page