Skip to main content

Enterprise Server 3.20 ist derzeit als Release Candidate verfügbar.

Verwenden der Überwachungsprotokoll-API für dein Unternehmen

Erfahren Sie, wie Sie Unternehmensereignisse programmgesteuert über die REST-API abrufen können.

Wer kann dieses Feature verwenden?

Enterprise owners and site administrators

Hinweis

Webhooks als Alternative zum Prüfprotokoll

Wahren Sie die Compliance und schützen Sie geistiges Eigentum mit Endpunkten, die auf das Überwachungsprotokoll verweisen. Weitere Informationen findest du unter REST-API-Endpunkte für Enterprise-Überwachungsprotokolle und REST-API-Endpunkte für Organisationen.

Weitere Informationen zu den spezifischen Ereignissen, auf die Sie über die Überwachungsprotokoll-Endpunkte zugreifen können, finden Sie in den folgenden Artikeln.

  •         [AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise)
    
  •         [AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-organization)
    
  •         [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/security-log-events)
    

Prüfprotokolldetails

Zeitstempel und Datumsfelder in der API-Antwort werden in UTC-Epochenmillisekunden gemessen.

Du kannst den Bereich read:audit_log verwenden, um mithilfe der API auf das Überwachungsprotokoll zuzugreifen.

Beispiel 1: Alle Ereignisse in einem Unternehmen, für ein bestimmtes Datum, mit Paginierung

Du kannst seitenbasierte Paginierung verwenden. Weitere Informationen zur Paginierung findest du unter Verwenden der Paginierung in der REST-API.

Die folgende Abfrage sucht nach Überwachungsprotokollereignissen, die am 1. Januar 2022 im Unternehmen avocado-corp erstellt wurden, und gibt die erste Seite mit maximal 100 Elementen pro Seite mithilfe der Paginierung zurück. Weitere Informationen zur Paginierung findest du unter Verwenden der Paginierung in der REST-API.

curl -H "Authorization: Bearer TOKEN" \
--request GET \
"http(s)://HOSTNAME/api/v3/enterprises/avocado-corp/audit-log?phrase=created:2022-01-01&page=1&per_page=100"

Beispiel 2: Ereignisse bei Pullanforderungen in einem Unternehmen, für ein bestimmtes Datum und einen bestimmten Akteur

Du kannst mehrere Suchbegriffe wie z. B. created und actor angeben, indem du sie in deiner formatierten URL mit dem Symbol + oder dem ASCII-Zeichencode %20 trennst.

Die folgende Abfrage sucht nach Überwachungsprotokollereignissen für Pullanforderungen, bei denen das Ereignis am oder nach dem 1. Januar 2022 im avocado-corp Unternehmen eingetreten ist und die Aktion vom Benutzer octocat ausgeführt wurde:

curl -H "Authorization: Bearer TOKEN" \
--request GET \
"http(s)://HOSTNAME/api/v3/enterprises/avocado-corp/audit-log?phrase=action:pull_request+created:>=2022-01-01+actor:octocat"

Beispiel 3: Ereignisse für Git-Aktivitäten in einem Unternehmen, für ein bestimmtes Datum und einen bestimmten Akteur

Sie können in einem Unternehmen nach Git-Ereignissen suchen, z. B. Klonen, Fetchen und Pushing, indem Sie include=git als Parameter in der URL hinzufügen. Alternativ können Sie auch include=all verwenden, um sowohl nach Web-Ereignissen als auch nach Git-Ereignissen zu suchen.

Die folgende Abfrage sucht nach Überwachungsprotokollereignissen für Git-Aktivitäten, bei denen das Ereignis nach dem 1. Januar 2024 im avocado-corp Unternehmen eingetreten ist und die Aktion vom Benutzer octocat ausgeführt wurde.

curl -H "Authorization: Bearer TOKEN" \
--request GET \
"http(s)://HOSTNAME/api/v3/enterprises/avocado-corp/audit-log?phrase=created:>=2024-01-01+actor:octocat&include=git"