GitHub Pages

The configuration for GitHub Pages for a repository.

APIs.ioEngineeringPlatform

Properties

Name Type Description
url string The API address for accessing this Page resource.
status string The status of the most recent build of the Page.
cname string The Pages site's custom domain
protected_domain_state string The state if the domain is verified
pending_domain_unverified_at string The timestamp when a pending domain becomes unverified.
custom_404 boolean Whether the Page has a custom 404 page.
html_url string The web address the Page can be accessed from.
build_type string The process in which the Page will be built.
source object
public boolean Whether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `r
https_certificate object
https_enforced boolean Whether https is enabled on the domain
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-page-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/page",
  "title": "GitHub Pages",
  "description": "The configuration for GitHub Pages for a repository.",
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "The API address for accessing this Page resource.",
      "format": "uri",
      "example": "https://api.github.com/repos/github/hello-world/pages"
    },
    "status": {
      "type": "string",
      "description": "The status of the most recent build of the Page.",
      "example": "built",
      "enum": [
        "built",
        "building",
        "errored"
      ],
      "nullable": true
    },
    "cname": {
      "description": "The Pages site's custom domain",
      "example": "example.com",
      "type": "string",
      "nullable": true
    },
    "protected_domain_state": {
      "type": "string",
      "description": "The state if the domain is verified",
      "example": "pending",
      "nullable": true,
      "enum": [
        "pending",
        "verified",
        "unverified"
      ]
    },
    "pending_domain_unverified_at": {
      "type": "string",
      "description": "The timestamp when a pending domain becomes unverified.",
      "nullable": true,
      "format": "date-time"
    },
    "custom_404": {
      "type": "boolean",
      "description": "Whether the Page has a custom 404 page.",
      "example": false,
      "default": false
    },
    "html_url": {
      "type": "string",
      "description": "The web address the Page can be accessed from.",
      "format": "uri",
      "example": "https://example.com"
    },
    "build_type": {
      "type": "string",
      "description": "The process in which the Page will be built.",
      "example": "legacy",
      "nullable": true,
      "enum": [
        "legacy",
        "workflow"
      ]
    },
    "source": {
      "$ref": "#/components/schemas/pages-source-hash"
    },
    "public": {
      "type": "boolean",
      "description": "Whether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site.",
      "example": true
    },
    "https_certificate": {
      "$ref": "#/components/schemas/pages-https-certificate"
    },
    "https_enforced": {
      "type": "boolean",
      "description": "Whether https is enabled on the domain",
      "example": true
    }
  },
  "required": [
    "url",
    "status",
    "cname",
    "custom_404",
    "public"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/apis-io-engineering-platform-page"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.