Github API

Getting access, Developing, Testing

Back to Github

Get a DNS health check for GitHub Pages

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.

To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the repo scope or Pages write permission is required. GitHub Apps must have the administrative:write and pages:write permissions.

Input

type: object properties: parameters: type: object properties: owner: type: string description: The account owner of the repository. The name is not case sensitive. repo: type: string description: The name of the repository. The name is not case sensitive. required: - owner - repo title: Parameters

Output

type: object title: Pages Health Check Status properties: domain: type: object properties: host: type: string uri: type: string nameservers: type: string dns_resolves: type: boolean is_proxied: type: boolean nullable: true is_cloudflare_ip: type: boolean nullable: true is_fastly_ip: type: boolean nullable: true is_old_ip_address: type: boolean nullable: true is_a_record: type: boolean nullable: true has_cname_record: type: boolean nullable: true has_mx_records_present: type: boolean nullable: true is_valid_domain: type: boolean is_apex_domain: type: boolean should_be_a_record: type: boolean nullable: true is_cname_to_github_user_domain: type: boolean nullable: true is_cname_to_pages_dot_github_dot_com: type: boolean nullable: true is_cname_to_fastly: type: boolean nullable: true is_pointed_to_github_pages_ip: type: boolean nullable: true is_non_github_pages_ip_present: type: boolean nullable: true is_pages_domain: type: boolean is_served_by_pages: type: boolean nullable: true is_valid: type: boolean reason: type: string nullable: true responds_to_https: type: boolean enforces_https: type: boolean https_error: type: string nullable: true is_https_eligible: type: boolean nullable: true caa_error: type: string nullable: true alt_domain: type: object properties: host: type: string uri: type: string nameservers: type: string dns_resolves: type: boolean is_proxied: type: boolean nullable: true is_cloudflare_ip: type: boolean nullable: true is_fastly_ip: type: boolean nullable: true is_old_ip_address: type: boolean nullable: true is_a_record: type: boolean nullable: true has_cname_record: type: boolean nullable: true has_mx_records_present: type: boolean nullable: true is_valid_domain: type: boolean is_apex_domain: type: boolean should_be_a_record: type: boolean nullable: true is_cname_to_github_user_domain: type: boolean nullable: true is_cname_to_pages_dot_github_dot_com: type: boolean nullable: true is_cname_to_fastly: type: boolean nullable: true is_pointed_to_github_pages_ip: type: boolean nullable: true is_non_github_pages_ip_present: type: boolean nullable: true is_pages_domain: type: boolean is_served_by_pages: type: boolean nullable: true is_valid: type: boolean reason: type: string nullable: true responds_to_https: type: boolean enforces_https: type: boolean https_error: type: string nullable: true is_https_eligible: type: boolean nullable: true caa_error: type: string nullable: true