pages_health_check

Creates, updates, deletes, gets or lists a pages_health_check resource.

Overview

Name	pages_health_check
Type	Resource
Id	github.repos.pages_health_check

Fields

The following fields are returned by SELECT queries:

get_pages_health_check

Response

Name	Datatype	Description
alt_domain	object
domain	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_pages_health_check	select	owner, repo		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
owner	string	The account owner of the repository. The name is not case sensitive.
repo	string	The name of the repository without the .git extension. The name is not case sensitive.

SELECT examples

get_pages_health_check

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.

SELECT
alt_domain,
domain
FROM github.repos.pages_health_check
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
;