Codeüberprüfung

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.

Codeüberprüfung - GitHub AE Docs

Verwende die REST-API zum Abrufen und Aktualisieren von code scanning-Warnungen eines Repositorys.

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

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

Seiten

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

https://web.archive.org/web/20231124085944/https://api.github.com/repos/octocat/Hello-World/contents/{+path}

Hello-World

Arbitrary file write during zip extraction

js/zipslip

CodeQL

Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "<a href="https://docs.github.com/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization">Managing security managers in your organization</a>."
To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the <code>repo</code> scope or <code>security_events</code> scope.
For public repositories, you may instead use the <code>public_repo</code> scope.

The organization name. The name is not case sensitive.

The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either <code>tool_name</code> or <code>tool_guid</code>, but not both.

tool_name

The name of the tool used to generate the code scanning analysis.

The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either <code>tool_guid</code> or <code>tool_name</code>, but not both.

tool_guid

The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.

A cursor, as given in the <a href="https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers">Link header</a>. If specified, the query only searches for results before this cursor.

before

A cursor, as given in the <a href="https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers">Link header</a>. If specified, the query only searches for results after this cursor.

after

Page number of the results to fetch.

page

The number of results per page (max 100).

per_page

The direction to sort the results by.

direction

If specified, only code scanning alerts with this state will be returned.

state

The property by which to sort the results.

sort

If specified, only code scanning alerts with this severity will be returned.

severity

List code scanning alerts for an organization

Lists code scanning alerts.
To use this endpoint, you must use an access token with the <code>security_events</code> scope or, for alerts from public repositories only, an access token with the <code>public_repo</code> scope.
The response includes a <code>most_recent_instance</code> object.
This provides details of the most recent instance of this alert
for the default branch (or for the specified Git reference if you used <code>ref</code> in the request).

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

The Git reference for the results you want to list. The <code>ref</code> for a branch can be formatted either as <code>refs/heads/&#x3C;branch name></code> or simply <code>&#x3C;branch name></code>. To reference a pull request use <code>refs/pull/&#x3C;number>/merge</code>.

The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/<number>/head`,
`refs/heads/<branch name>` or simply `<branch name>`.

Response if GitHub Advanced Security is not enabled for this repository

List code scanning alerts for a repository

This path depends on a user-provided value.

Arbitrary file write during zip extraction ("Zip Slip")

Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.

The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.

The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.

**Required when the state is dismissed.** The reason for dismissing or closing the alert.

The REST API URL for fetching the list of instances for an alert.

Gets a single code scanning alert. You must use an access token with the <code>security_events</code> scope to use this endpoint with private repos, the <code>public_repo</code> scope also grants permission to read security events on public repos only.

The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the <code>number</code> field in the response from the <code>GET /repos/{owner}/{repo}/code-scanning/alerts</code> operation.

alert_number

Get a code scanning alert

Sets the state of the code scanning alert. You must provide <code>dismissed_reason</code> when you set the state to <code>dismissed</code>.

Required when the state is dismissed. The reason for dismissing or closing the alert.

dismissed_reason

Updates the status of a single code scanning alert. You must use an access token with the <code>security_events</code> scope to use this endpoint. GitHub Apps must have the <code>security_events</code> write permission to use this endpoint.

Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository

Update a code scanning alert

This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1.

Lists all instances of the specified code scanning alert.
You must use an access token with the <code>security_events</code> scope to use this endpoint with private repos,
the <code>public_repo</code> scope also grants permission to read security events on public repos only.