docs/data/reusables/rest-reference/pages/pages.md

The {% data variables.product.prodname_pages %} API retrieves information about your {% data variables.product.prodname_pages %} configuration, and the statuses of your builds. Information about the site and the builds can only be accessed by authenticated owners{% ifversion not ghae %}, even if the websites are public{% endif %}. For more information, see "About {% data variables.product.prodname_pages %}."

In {% data variables.product.prodname_pages %} API endpoints with a status key in their response, the value can be one of:

• null: The site has yet to be built.
• queued: The build has been requested but not yet begun.
• building:The build is in progress.
• built: The site has been built.
• errored: Indicates an error occurred during the build.

In {% data variables.product.prodname_pages %} API endpoints that return GitHub Pages site information, the JSON responses include these fields:

• html_url: The absolute URL (including scheme) of the rendered Pages site. For example, https://username.github.io.
• source: An object that contains the source branch and directory for the rendered Pages site. This includes:
  • branch: The repository branch used to publish your site's source files. For example, main or gh-pages.
  • path: The repository directory from which the site publishes. Will be either / or /docs.