GitHub: Get a DNS health check for Git Hub Pages

GitHub repos.reposGetPagesHealthCheck: arguments, response, policy and SDK examples.

Operation github.repos_get_pages_health_check

Provider route: GET /repos/{owner}/{repo}/pages/health. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["repos"]["reposGetPagesHealthCheck"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.repos.reposGetPagesHealthCheck(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.repos.repos_get_pages_health_check(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.owner`	string	Required within parent
`path.repo`	string	Required within parent

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	Model	Alternative	Expand Get a DNS health check for Git Hub Pages — response body — Pages Health Check Status
`$ (anyOf 2)`	Model	Alternative	Expand Re-run a workflow — response body

Referenced models: Re-run a workflow — response body, Get a DNS health check for Git Hub Pages — response body — Pages Health Check Status

Schemas

Re-run a workflow — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	An object without any properties. Additional keys: not allowed

Get a DNS health check for Git Hub Pages — response body — Pages Health Check Status

Field	Type	Presence	Description and constraints
`$`	object	Root	Pages Health Check Status
`alt_domain`	JSON	Optional
`alt_domain (anyOf 1)`	Model	Alternative	Expand Get a DNS health check for Git Hub Pages — response body — Pages Health Check Status domain
`alt_domain (anyOf 2)`	null	Alternative
`domain`	Model	Optional	Expand Get a DNS health check for Git Hub Pages — response body — Pages Health Check Status domain

Referenced models: Get a DNS health check for Git Hub Pages — response body — Pages Health Check Status domain

Get a DNS health check for Git Hub Pages — response body — Pages Health Check Status domain

Field	Type	Presence
`$`	object	Root
`caa_error`	JSON	Optional
`caa_error (anyOf 1)`	string	Alternative
`caa_error (anyOf 2)`	null	Alternative
`dns_resolves`	boolean	Optional
`enforces_https`	boolean	Optional
`has_cname_record`	JSON	Optional
`has_cname_record (anyOf 1)`	boolean	Alternative
`has_cname_record (anyOf 2)`	null	Alternative
`has_mx_records_present`	JSON	Optional
`has_mx_records_present (anyOf 1)`	boolean	Alternative
`has_mx_records_present (anyOf 2)`	null	Alternative
`host`	string	Optional
`https_error`	JSON	Optional
`https_error (anyOf 1)`	string	Alternative
`https_error (anyOf 2)`	null	Alternative
`is_a_record`	JSON	Optional
`is_a_record (anyOf 1)`	boolean	Alternative
`is_a_record (anyOf 2)`	null	Alternative
`is_apex_domain`	boolean	Optional
`is_cloudflare_ip`	JSON	Optional
`is_cloudflare_ip (anyOf 1)`	boolean	Alternative
`is_cloudflare_ip (anyOf 2)`	null	Alternative
`is_cname_to_fastly`	JSON	Optional
`is_cname_to_fastly (anyOf 1)`	boolean	Alternative
`is_cname_to_fastly (anyOf 2)`	null	Alternative
`is_cname_to_github_user_domain`	JSON	Optional
`is_cname_to_github_user_domain (anyOf 1)`	boolean	Alternative
`is_cname_to_github_user_domain (anyOf 2)`	null	Alternative
`is_cname_to_pages_dot_github_dot_com`	JSON	Optional
`is_cname_to_pages_dot_github_dot_com (anyOf 1)`	boolean	Alternative
`is_cname_to_pages_dot_github_dot_com (anyOf 2)`	null	Alternative
`is_fastly_ip`	JSON	Optional
`is_fastly_ip (anyOf 1)`	boolean	Alternative
`is_fastly_ip (anyOf 2)`	null	Alternative
`is_https_eligible`	JSON	Optional
`is_https_eligible (anyOf 1)`	boolean	Alternative
`is_https_eligible (anyOf 2)`	null	Alternative
`is_non_github_pages_ip_present`	JSON	Optional
`is_non_github_pages_ip_present (anyOf 1)`	boolean	Alternative
`is_non_github_pages_ip_present (anyOf 2)`	null	Alternative
`is_old_ip_address`	JSON	Optional
`is_old_ip_address (anyOf 1)`	boolean	Alternative
`is_old_ip_address (anyOf 2)`	null	Alternative
`is_pages_domain`	boolean	Optional
`is_pointed_to_github_pages_ip`	JSON	Optional
`is_pointed_to_github_pages_ip (anyOf 1)`	boolean	Alternative
`is_pointed_to_github_pages_ip (anyOf 2)`	null	Alternative
`is_proxied`	JSON	Optional
`is_proxied (anyOf 1)`	boolean	Alternative
`is_proxied (anyOf 2)`	null	Alternative
`is_served_by_pages`	JSON	Optional
`is_served_by_pages (anyOf 1)`	boolean	Alternative
`is_served_by_pages (anyOf 2)`	null	Alternative
`is_valid`	boolean	Optional
`is_valid_domain`	boolean	Optional
`nameservers`	string	Optional
`reason`	JSON	Optional
`reason (anyOf 1)`	string	Alternative
`reason (anyOf 2)`	null	Alternative
`responds_to_https`	boolean	Optional
`should_be_a_record`	JSON	Optional
`should_be_a_record (anyOf 1)`	boolean	Alternative
`should_be_a_record (anyOf 2)`	null	Alternative
`uri`	string	Optional

Policy, approvals and errors

SDK function policy ID: github.repos_get_pages_health_check. Catalog operation: repos/get-pages-health-check. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source

Report an issue with this page