---
title: "Get a DNS health check for GitHub Pages"
method: GET
path: "/repos/{owner}/{repo}/pages/health"
tags: ["repos"]
---

# Get a DNS health check for GitHub Pages

`GET /repos/{owner}/{repo}/pages/health`

Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages.

The first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response.

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

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

## Path parameters

- `owner` string, required
- `repo` string, required

## Response `200`

Response

- PagesHealthCheck — Pages Health Check Status
  - `domain` object
    - `host` string
    - `uri` string
    - `nameservers` string
    - `dns_resolves` boolean
    - `is_proxied` boolean, nullable
    - `is_cloudflare_ip` boolean, nullable
    - `is_fastly_ip` boolean, nullable
    - `is_old_ip_address` boolean, nullable
    - `is_a_record` boolean, nullable
    - `has_cname_record` boolean, nullable
    - `has_mx_records_present` boolean, nullable
    - `is_valid_domain` boolean
    - `is_apex_domain` boolean
    - `should_be_a_record` boolean, nullable
    - `is_cname_to_github_user_domain` boolean, nullable
    - `is_cname_to_pages_dot_github_dot_com` boolean, nullable
    - `is_cname_to_fastly` boolean, nullable
    - `is_pointed_to_github_pages_ip` boolean, nullable
    - `is_non_github_pages_ip_present` boolean, nullable
    - `is_pages_domain` boolean
    - `is_served_by_pages` boolean, nullable
    - `is_valid` boolean
    - `reason` string, nullable
    - `responds_to_https` boolean
    - `enforces_https` boolean
    - `https_error` string, nullable
    - `is_https_eligible` boolean, nullable
    - `caa_error` string, nullable
  - `alt_domain` object, nullable
    - `host` string
    - `uri` string
    - `nameservers` string
    - `dns_resolves` boolean
    - `is_proxied` boolean, nullable
    - `is_cloudflare_ip` boolean, nullable
    - `is_fastly_ip` boolean, nullable
    - `is_old_ip_address` boolean, nullable
    - `is_a_record` boolean, nullable
    - `has_cname_record` boolean, nullable
    - `has_mx_records_present` boolean, nullable
    - `is_valid_domain` boolean
    - `is_apex_domain` boolean
    - `should_be_a_record` boolean, nullable
    - `is_cname_to_github_user_domain` boolean, nullable
    - `is_cname_to_pages_dot_github_dot_com` boolean, nullable
    - `is_cname_to_fastly` boolean, nullable
    - `is_pointed_to_github_pages_ip` boolean, nullable
    - `is_non_github_pages_ip_present` boolean, nullable
    - `is_pages_domain` boolean
    - `is_served_by_pages` boolean, nullable
    - `is_valid` boolean
    - `reason` string, nullable
    - `responds_to_https` boolean
    - `enforces_https` boolean
    - `https_error` string, nullable
    - `is_https_eligible` boolean, nullable
    - `caa_error` string, nullable

## Other responses

- `202` — Empty response
- `400` — Custom domains are not available for GitHub Pages
- `404` — Resource not found
- `422` — There isn't a CNAME for this page

---

[API](https://skmtc.net/github/apis/github-v3-rest-api-2.md) · [All operations](https://skmtc.net/github/apis/github-v3-rest-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/github/github-v3-rest-api-2/versions/8ae6d0c8716e/schema)