Seiten

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

Alle GitHub-Dokumente sind Open Source-Dokumente. Ist dir etwas Falsches oder Unklares aufgefallen? Bitte sende einen Pull Request.

Hilf uns, diese Dokumente perfekt zu machen!

Aktionen

Gib einen Suchbegriff ein, um ihn in der GitHub-Dokumentation zu finden.

Seiten - GitHub AE Docs

Verwende die REST-API, um mit GitHub Pages-Websites und -Builds zu interagieren.

Schnellstart

Vergleich der GitHub-APIs

Ressourcen in der REST-API

Rate limits

Medientypen

Authentifizierung

Schützen von API-Anmeldeinformationen

Problembehandlung

Libraries

Issue-Ereignistypen

GitHub-Ereignistypen

Endpunkt für GitHub-App-Installationszugriffstoken

Endpunkte für GitHub-App-Benutzertoken

Berechtigungen für GitHub-Apps

Übersicht

Verwenden der API

Erstellen von Skripts mit JavaScript

Skript mit Ruby

Ermitteln von Ressourcen für einzelne Benutzer*innen

Übermitteln von Bereitstellungen

Rendern von Daten als Graphen

Arbeiten mit Kommentaren

Paginierung

Erstellen eines CI-Servers

Bewährte Methoden

Erste Schritte: Git-Datenbank

Erste Schritte: Überprüfungen

Verschlüsseln von Geheimnissen

Anleitungen

Artifacts

Berechtigungen

Geheimnisse

Selbstgehostete Runnergruppen

Selbstgehostete Runner

Workflowaufträge

Workflowausführungen

Workflows

Events

Feeds

Benachrichtigungen

Versehen mit einem Stern

Watching (Überwachung)

Aktivität

GitHub Apps

Installationen

OAuth-Autorisierungen

webhooks

Apps

Branches

Geschützte Branches

Überprüfungsausführungen

Prüfsuiten

Prüfungen

Codeüberprüfung

Verhaltensregeln

Projektmitarbeiter

Einladungen

Commits

Commit-Kommentare

Commitstatus

Schlüssel bereitstellen

Richtlinien für Bereitstellungsbranches

Bereitstellungen

Umgebungen

Bereitstellungsstatus

Emojis

Administratorstatistiken

Ankündigung

Überwachungsprotokoll

Globale Webhooks

Lizenz

Organisationen

Pre-Receive-Umgebungen

Benutzer

Enterprise-Verwaltung

Gists

Kommentare

BLOBs

References

Strukturen

Git-Datenbank

Gitignore

Probleme

Bearbeiter

Ereignisse

Bezeichnungen

Meilensteine

Zeitachse

Lizenzen

Markdown

Statistik

Metriken

Migrationen

Member

Externe Mitwirkende

Boards

Cards

Spalten

Project boards

Pulls

Rezensionskommentare

Reviewanfragen

Überprüfungen

Rate Limit

Reaktionen

Releases

Releaseressourcen

Autolinks

Inhalte

Radgabeln

Git LFS

Repositorys

Webhooks

Suchen,

Geheime Überprüfung

Teams

Diskussionskommentare

Diskussionen

Externe Gruppen

Follower

GPG-Schlüssel

Git-SSH-Schlüssel

REST-API

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