# page

From **GitHub v3 REST API**.

The configuration for GitHub Pages for a repository.

- Type: `object`

## Properties

### `cname`

- Required: true
- Type: `string`
- Nullable: true
- Example: `example.com`

The Pages site's custom domain

### `custom_404`

- Required: true
- Type: `boolean`
- Default: `false`
- Example: `false`

Whether the Page has a custom 404 page.

### `html_url`

- Required: false
- Type: `string`
- Format: `uri`
- Example: `https://example.com`

The web address the Page can be accessed from.

### `https_certificate`

- Required: false
- Type: `object`

### `https_enforced`

- Required: false
- Type: `boolean`
- Example: `true`

Whether https is enabled on the domain

### `pending_domain_unverified_at`

- Required: false
- Type: `string`
- Format: `date-time`
- Nullable: true

The timestamp when a pending domain becomes unverified.

### `protected_domain_state`

- Required: false
- Type: `string`
- Nullable: true
- Example: `pending`
- Allowed values: `"pending"`, `"verified"`, `"unverified"`

The state if the domain is verified

### `public`

- Required: true
- Type: `boolean`
- Example: `true`

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.

### `source`

- Required: false
- Type: `object`

### `status`

- Required: true
- Type: `string`
- Nullable: true
- Example: `built`
- Allowed values: `"built"`, `"building"`, `"errored"`

The status of the most recent build of the Page.

### `url`

- Required: true
- Type: `string`
- Format: `uri`
- Example: `https://api.github.com/repos/github/hello-world/pages`

The API address for accessing this Page resource.

## JSON Schema

```json
{"description":"The configuration for GitHub Pages for a repository.","properties":{"cname":{"description":"The Pages site's custom domain","example":"example.com","nullable":true,"type":"string"},"custom_404":{"default":false,"description":"Whether the Page has a custom 404 page.","example":false,"type":"boolean"},"html_url":{"description":"The web address the Page can be accessed from.","example":"https://example.com","format":"uri","type":"string"},"https_certificate":{"$ref":"#/components/schemas/pages-https-certificate"},"https_enforced":{"description":"Whether https is enabled on the domain","example":true,"type":"boolean"},"pending_domain_unverified_at":{"description":"The timestamp when a pending domain becomes unverified.","format":"date-time","nullable":true,"type":"string"},"protected_domain_state":{"description":"The state if the domain is verified","enum":["pending","verified","unverified"],"example":"pending","nullable":true,"type":"string"},"public":{"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,"type":"boolean"},"source":{"$ref":"#/components/schemas/pages-source-hash"},"status":{"description":"The status of the most recent build of the Page.","enum":["built","building","errored"],"example":"built","nullable":true,"type":"string"},"url":{"description":"The API address for accessing this Page resource.","example":"https://api.github.com/repos/github/hello-world/pages","format":"uri","type":"string"}},"required":["url","status","cname","custom_404","public"],"title":"GitHub Pages","type":"object"}
```