Páginas

Enterprise Cloud

Enterprise Server 3.10

Enterprise Server 3.11

Enterprise Server 3.6

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

REST API

Toda la documentación de GitHub es de código abierto. ¿Ve algo incorrecto o que no esté claro? Envíe una solicitud de incorporación de cambios.

¡Ayúdanos a hacer geniales estos documentos!

Consulta el vídeo de esta transcripción.

Acciones

Introduzca un término de búsqueda para encontrarlo en la documentación de GitHub.

Páginas - GitHub AE Docs

Usa la API de REST para interactuar con los sitios y compilaciones de GitHub Pages.

Inicio rápido

Comparación de las API de GitHub

Recursos en la API de REST

Rate limits

Tipos de medios

Autenticación

Protección de las credenciales de API

Troubleshooting

Libraries

Tipos de eventos de los informes de problemas

Tipos de evento de GitHub

Puntos de conexión para tokens de instalación de aplicaciones de GitHub

Puntos de conexión para tokens de usuario de aplicaciones de GitHub

Permisos para instancias de GitHub App

Información general

Uso de la API

Script con JavaScript

Script con Ruby

Descubrimiento de recursos para un usuario

Entregar despliegues

Representar los datos en gráficas

Trabajar con los comentarios

Paginación

Crear un servidor de IC

procedimientos recomendados

Introducción: base de datos de Git

Introducción: Comprobaciones

Cifrado de secretos

Guías

Artifacts

Permisos

Secretos

Grupos de ejecutores auto-hospedados

Ejecutores autohospedados

Jobs de los flujos de trabajo

Ejecuciones de flujo de trabajo

Workflows

Eventos

Fuentes

Notificaciones

Marcar con una estrella

Observando

Actividad

Aplicaciones de GitHub

Instalaciones

Autorizaciones de OAuth

webhooks

Aplicaciones

Ramas

Ramas protegidas

Ejecuciones de Verificación

Conjuntos de Verificaciones

Comprobaciones

Examen del código

Códigos de conducta

Colaboradores

Invitaciones

Confirmaciones

Comentarios sobre confirmación de cambios

Estados de confirmación

Claves de implementación

Directivas de rama de implementación

Implementaciones

Entornos

Estados de despliegue

Emojis

Estadísticas de los Administradores

Anuncio

Registro de auditoría

Webhooks globales

Licencia

Las organizaciones

Ambientes de pre-recepción

Usuarios

Administración empresarial

Gists

Comentarios

Datos BLOB

Referencias

Etiquetas

Árboles

Base de datos de Git

Gitignore

Incidencias

Asignados

Hitos

Escala de tiempo

Licencias

Markdown

Estadísticas

Métricas

Migraciones

Miembros

Colaboradores externos

Boards

Cards

Columnas

Project boards

Extracciones

Revisar comentarios

Solicitudes de revisión

Revisiones

Límite de frecuencia

Reacciones

Versiones

Recursos de versión

Vínculos automáticos

Contenido

Horquillas

Git LFS

Repositorios

Webhooks

Search

Análisis de secretos

Teams

Comentarios de debate

Debates

Grupos externos

Seguidores

Claves GPG

Claves SSH de Git

API DE REST

The configuration for GitHub Pages for a repository.

The process in which the Page will be built.

The web address the Page can be accessed from.

Pages Https Certificate

The timestamp when a pending domain becomes unverified.

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.

Pages Source Hash

The status of the most recent build of the Page.

The API address for accessing this Page resource.

GitHub Pages

Gets information about a GitHub AE Pages site.
A token with the <code>repo</code> scope is required. GitHub Apps must have the <code>pages:read</code> permission.

The account owner of the repository. The name is not case sensitive.

owner

The name of the repository without the <code>.git</code> extension. The name is not case sensitive.

repo

Get a GitHub AE Pages site

The process in which the Page will be built. Possible values are <code>"legacy"</code> and <code>"workflow"</code>.

build_type

The repository branch used to publish your site's source files.

branch

The repository directory that includes the source files for the Pages site. Allowed paths are <code>/</code> or <code>/docs</code>. Default: <code>/</code>

path

The source branch and directory used to publish your Pages site.

source

Configures a GitHub AE Pages site. For more information, see "<a href="/github/working-with-github-pages/about-github-pages">About GitHub Pages</a>."
To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the <code>repo</code> scope or Pages write permission is required. GitHub Apps must have the <code>administration:write</code> and <code>pages:write</code> permissions.

Validation failed, or the endpoint has been spammed.

Create a GitHub AE Pages site

Specify a custom domain for the repository. Sending a <code>null</code> value will remove the custom domain. For more about custom domains, see "<a href="https://docs.github.com/github-ae@latest/articles/using-a-custom-domain-with-github-pages/">Using a custom domain with GitHub Pages</a>."

cname

Specify whether HTTPS should be enforced for the repository.

https_enforced

The process by which the GitHub Pages site will be built. <code>workflow</code> means that the site is built by a custom GitHub Actions workflow. <code>legacy</code> means that the site is built by GitHub when changes are pushed to a specific branch.

The repository directory that includes the source files for the Pages site. Allowed paths are <code>/</code> or <code>/docs</code>.

Update the source for the repository. Must include the branch name and path.

Updates information for a GitHub AE Pages site. For more information, see "<a href="/github/working-with-github-pages/about-github-pages">About GitHub Pages</a>.
To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the <code>repo</code> scope or Pages write permission is required. GitHub Apps must have the <code>administration:write</code> and <code>pages:write</code> permissions.

Update information about a GitHub AE Pages site

Deletes a GitHub AE Pages site. For more information, see "<a href="/github/working-with-github-pages/about-github-pages">About GitHub Pages</a>.
To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the <code>repo</code> scope or Pages write permission is required. GitHub Apps must have the <code>administration:write</code> and <code>pages:write</code> permissions.

Delete a GitHub AE Pages site

Page Build

Lists builts of a GitHub AE Pages site.
A token with the <code>repo</code> scope is required. GitHub Apps must have the <code>pages:read</code> permission.

The number of results per page (max 100).

per_page

Page number of the results to fetch.

page

List GitHub AE Pages builds

Page Build Status

You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.

Request a GitHub AE Pages build

Gets information about the single most recent build of a GitHub AE Pages site.
A token with the <code>repo</code> scope is required. GitHub Apps must have the <code>pages:read</code> permission.

Get latest Pages build

Gets information about a GitHub AE Pages build.
A token with the <code>repo</code> scope is required. GitHub Apps must have the <code>pages:read</code> permission.

build_id

Get GitHub AE Pages build