reposGetPagesHealthCheck
Get a DNS health check for GitHub Pages
Details
- Method:
GET - Path:
/repos/{owner}/{repo}/pages/health - Operation ID:
repos/get-pages-health-check
Parameters
{
"owner": {
"description": "The account owner of the repository. The name is not case sensitive.",
"required": true,
"location": "path",
"type": "string"
},
"repo": {
"description": "The name of the repository without the `.git` extension. The name is not case sensitive.",
"required": true,
"location": "path",
"type": "string"
}
}Response Schema
{
"title": "Pages Health Check Status",
"description": "Pages Health Check Status",
"type": "object",
"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",
"nullable": true,
"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
}
}
}
}
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('github')
# Call this tool
result = await agent.call_tool('reposGetPagesHealthCheck', {
# Add required parameters here
})