|
66563 | 66563 | } |
66564 | 66564 | ] |
66565 | 66565 | }, |
| 66566 | + { |
| 66567 | + "verb": "get", |
| 66568 | + "requestPath": "/repos/{owner}/{repo}/pages/health", |
| 66569 | + "serverUrl": "https://api.github.com", |
| 66570 | + "parameters": [ |
| 66571 | + { |
| 66572 | + "name": "owner", |
| 66573 | + "in": "path", |
| 66574 | + "required": true, |
| 66575 | + "schema": { |
| 66576 | + "type": "string" |
| 66577 | + }, |
| 66578 | + "descriptionHTML": "" |
| 66579 | + }, |
| 66580 | + { |
| 66581 | + "name": "repo", |
| 66582 | + "in": "path", |
| 66583 | + "required": true, |
| 66584 | + "schema": { |
| 66585 | + "type": "string" |
| 66586 | + }, |
| 66587 | + "descriptionHTML": "" |
| 66588 | + } |
| 66589 | + ], |
| 66590 | + "x-codeSamples": [ |
| 66591 | + { |
| 66592 | + "lang": "Shell", |
| 66593 | + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/health", |
| 66594 | + "html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/health</code></pre>" |
| 66595 | + }, |
| 66596 | + { |
| 66597 | + "lang": "JavaScript", |
| 66598 | + "source": "await octokit.request('GET /repos/{owner}/{repo}/pages/health', {\n owner: 'octocat',\n repo: 'hello-world'\n})", |
| 66599 | + "html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /repos/{owner}/{repo}/pages/health'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>\n})\n</code></pre>" |
| 66600 | + } |
| 66601 | + ], |
| 66602 | + "summary": "Get a DNS health check for GitHub Pages", |
| 66603 | + "description": "Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages.\n\nThe 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.\n\nUsers must have admin or owner permissions. GitHub Apps must have the `pages:write` and `administration:write` permission to use this endpoint.", |
| 66604 | + "tags": [ |
| 66605 | + "repos" |
| 66606 | + ], |
| 66607 | + "operationId": "repos/get-pages-health-check", |
| 66608 | + "externalDocs": { |
| 66609 | + "description": "API method documentation", |
| 66610 | + "url": "https://docs.github.com/rest/reference/repos#get-a-dns-health-check-for-github-pages" |
| 66611 | + }, |
| 66612 | + "x-github": { |
| 66613 | + "githubCloudOnly": false, |
| 66614 | + "enabledForGitHubApps": true, |
| 66615 | + "category": "repos", |
| 66616 | + "subcategory": "pages" |
| 66617 | + }, |
| 66618 | + "slug": "get-a-dns-health-check-for-github-pages", |
| 66619 | + "category": "repos", |
| 66620 | + "categoryLabel": "Repos", |
| 66621 | + "subcategory": "pages", |
| 66622 | + "subcategoryLabel": "Pages", |
| 66623 | + "notes": [], |
| 66624 | + "bodyParameters": [], |
| 66625 | + "descriptionHTML": "<p>Gets a health check of the DNS settings for the <code>CNAME</code> record configured for a repository's GitHub Pages.</p>\n<p>The first request to this endpoint returns a <code>202 Accepted</code> 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 <code>200 OK</code> status with the health check results in the response.</p>\n<p>Users must have admin or owner permissions. GitHub Apps must have the <code>pages:write</code> and <code>administration:write</code> permission to use this endpoint.</p>", |
| 66626 | + "responses": [ |
| 66627 | + { |
| 66628 | + "httpStatusCode": "200", |
| 66629 | + "httpStatusMessage": "OK", |
| 66630 | + "description": "Response", |
| 66631 | + "payload": "<pre><code class=\"hljs language-json\">{\n <span class=\"hljs-attr\">\"domain\"</span>: {\n <span class=\"hljs-attr\">\"host\"</span>: <span class=\"hljs-string\">\"example.com\"</span>,\n <span class=\"hljs-attr\">\"uri\"</span>: <span class=\"hljs-string\">\"http://example.com/\"</span>,\n <span class=\"hljs-attr\">\"nameservers\"</span>: <span class=\"hljs-string\">\"default\"</span>,\n <span class=\"hljs-attr\">\"dns_resolves\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"is_proxied\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_cloudflare_ip\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_fastly_ip\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_old_ip_address\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_a_record\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"has_cname_record\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"has_mx_records_present\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_valid_domain\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"is_apex_domain\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"should_be_a_record\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"is_cname_to_github_user_domain\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_cname_to_pages_dot_github_dot_com\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_cname_to_fastly\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_pointed_to_github_pages_ip\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"is_non_github_pages_ip_present\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_pages_domain\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_served_by_pages\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"is_valid\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"reason\"</span>: <span class=\"hljs-literal\">null</span>,\n <span class=\"hljs-attr\">\"responds_to_https\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"enforces_https\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"https_error\"</span>: <span class=\"hljs-literal\">null</span>,\n <span class=\"hljs-attr\">\"is_https_eligible\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"caa_error\"</span>: <span class=\"hljs-literal\">null</span>\n },\n <span class=\"hljs-attr\">\"alt_domain\"</span>: {\n <span class=\"hljs-attr\">\"host\"</span>: <span class=\"hljs-string\">\"www.example.com\"</span>,\n <span class=\"hljs-attr\">\"uri\"</span>: <span class=\"hljs-string\">\"http://www.example.com/\"</span>,\n <span class=\"hljs-attr\">\"nameservers\"</span>: <span class=\"hljs-string\">\"default\"</span>,\n <span class=\"hljs-attr\">\"dns_resolves\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"is_proxied\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_cloudflare_ip\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_fastly_ip\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_old_ip_address\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_a_record\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"has_cname_record\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"has_mx_records_present\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_valid_domain\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"is_apex_domain\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"should_be_a_record\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"is_cname_to_github_user_domain\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_cname_to_pages_dot_github_dot_com\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_cname_to_fastly\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_pointed_to_github_pages_ip\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"is_non_github_pages_ip_present\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_pages_domain\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_served_by_pages\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"is_valid\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"reason\"</span>: <span class=\"hljs-literal\">null</span>,\n <span class=\"hljs-attr\">\"responds_to_https\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"enforces_https\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"https_error\"</span>: <span class=\"hljs-literal\">null</span>,\n <span class=\"hljs-attr\">\"is_https_eligible\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"caa_error\"</span>: <span class=\"hljs-literal\">null</span>\n }\n}\n</code></pre>" |
| 66632 | + }, |
| 66633 | + { |
| 66634 | + "httpStatusCode": "202", |
| 66635 | + "httpStatusMessage": "Accepted", |
| 66636 | + "description": "Empty response" |
| 66637 | + }, |
| 66638 | + { |
| 66639 | + "httpStatusCode": "400", |
| 66640 | + "httpStatusMessage": "Bad Request", |
| 66641 | + "description": "Custom domains are not available for GitHub Pages" |
| 66642 | + }, |
| 66643 | + { |
| 66644 | + "httpStatusCode": "404", |
| 66645 | + "httpStatusMessage": "Not Found", |
| 66646 | + "description": "Resource not found" |
| 66647 | + }, |
| 66648 | + { |
| 66649 | + "httpStatusCode": "422", |
| 66650 | + "httpStatusMessage": "Unprocessable Entity", |
| 66651 | + "description": "There isn't a CNAME for this page" |
| 66652 | + } |
| 66653 | + ] |
| 66654 | + }, |
66566 | 66655 | { |
66567 | 66656 | "verb": "get", |
66568 | 66657 | "requestPath": "/repos/{owner}/{repo}/projects", |
|
0 commit comments