GitHub Pages

The GitHub Pages deployment status.

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
status_url	string	The URI to monitor GitHub Pages deployment status.
page_url	string	The URI to the deployed GitHub Pages.
preview_url	string	The URI to the deployed GitHub Pages preview.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/page-deployment",
  "title": "GitHub Pages",
  "description": "The GitHub Pages deployment status.",
  "type": "object",
  "properties": {
    "status_url": {
      "type": "string",
      "description": "The URI to monitor GitHub Pages deployment status.",
      "format": "uri",
      "example": "https://api.github.com/repos/github/hello-world/pages/deployment/status/4fd754f7e594640989b406850d0bc8f06a121251"
    },
    "page_url": {
      "type": "string",
      "description": "The URI to the deployed GitHub Pages.",
      "format": "uri",
      "example": "hello-world.github.io"
    },
    "preview_url": {
      "type": "string",
      "description": "The URI to the deployed GitHub Pages preview.",
      "format": "uri",
      "example": "monalisa-1231a2312sa32-23sda74.drafts.github.io"
    }
  },
  "required": [
    "status_url",
    "page_url"
  ]
}