Seiten

Enterprise Cloud

Enterprise Server 3.10

Enterprise Server 3.11

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-Dokumentation

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

API-Versionen

Medientypen

Authentifizierung

Schützen von API-Anmeldeinformationen

Problembehandlung

Libraries

OpenAPI-Beschreibung

Issue-Ereignistypen

GitHub-Ereignistypen

Endpunkt für GitHub-App-Installationszugriffstoken

Endpunkte für GitHub-App-Benutzertoken

Endpunkte für differenzierte PATs

Berechtigungen für GitHub-Apps

Berechtigungen für differenzierte PATs

Aktuelle Änderungen

Ü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

Cache

OIDC

Berechtigungen

Geheimnisse

Selbstgehostete Runner

Variablen

Workflowaufträge

Workflowausführungen

Workflows

Events

Feeds

Benachrichtigungen

Versehen mit einem Stern

Watching (Überwachung)

Aktivität

GitHub Apps

Installationen

Marketplace

OAuth-Autorisierungen

webhooks

Apps

Abrechnung

Branches

Geschützte Branches

Überprüfungsausführungen

Prüfsuiten

Prüfungen

Klassenzimmer

Codeüberprüfung

Verhaltensregeln

Codespaces

Organisationen

Organisationsgeheimnisse

Machines

Repositorygeheimnisse

Benutzergeheimnisse

Projektmitarbeiter

Einladungen

Commits

Commit-Kommentare

Commitstatus

Copilot business

Copilot

Alerts

Dependabot

Abhängigkeitsüberprüfung

Abhängigkeitsübermittlung

Software-Stückliste (Software Bill of Materials, SBOM)

Abhängigkeitsdiagramm

Schlüssel bereitstellen

Richtlinien für Bereitstellungsbranches

Bereitstellungen

Umgebungen

Schutzregeln

Bereitstellungsstatus

Emojis

Gists

Kommentare

BLOBs

References

Strukturen

Git-Datenbank

Gitignore

Organization

Repository

Benutzer

Interaktionen

Probleme

Bearbeiter

Ereignisse

Bezeichnungen

Meilensteine

Zeitachse

Lizenzen

Markdown

Community

Statistik

Verkehr

Metriken

Quellimporte

Migrationen

Blockieren von Benutzern

Custom properties

Member

Organisationsrollen

Externe Mitwirkende

Persönliche Zugriffstoken

Regelsammlungen

Regeln

Sicherheits-Manager

Pakete

Boards

Cards

Spalten

Projects (classic)

Pulls

Rezensionskommentare

Reviewanfragen

Überprüfungen

Rate Limit

Reaktionen

Releases

Releaseressourcen

Autolinks

Inhalte

Radgabeln

Repositorys

Regelsammlung

Webhooks

Suchen,

Geheime Überprüfung

Globale Sicherheitsempfehlungen

Sicherheitsempfehlungen für Repositorys

Sicherheitsempfehlungen

Teams

Diskussionskommentare

Diskussionen

E-Mails

Follower

GPG-Schlüssel

Git-SSH-Schlüssel

SSH-Signaturschlüssel

Konten für soziale Netzwerke

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 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 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 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.

Create a GitHub Pages site