Asset-Logs-API

Endpoints zum Abfragen von Geräte-Aktivitätsprotokolleinträgen

Geschrieben von Erdinc Akay

Zuletzt aktualisiert Vor 26 Tagen

Ruft Aktivitätsprotokolleinträge ab, die für ein Gerät erfasst wurden. Protokolleinträge werden automatisch von der Plattform geschrieben, wenn Remote-Aktionen durchgeführt, Terminal-Sitzungen geöffnet oder geschlossen, automatisierte Tasks ausgeführt, Patch-Aktivitäten verzeichnet oder Software auf einem Gerät verteilt wird.

Die vollständige, stets aktuelle Liste der Endpoints, Parameter und Antwortfelder für die Version, die du betreibst, findest du in der interaktiven OpenAPI-Oberfläche (Swagger) unter https://<deine-octoja-instanz>/openapi/index.html.

Endpoint

OperationEndpointHinweise
Protokolleinträge filternPOST /api/asset-logs/filterErfordert Authentifizierung — der Aufrufer muss ein angemeldeter Benutzer sein. Gibt Einträge sortiert nach Zeitstempel absteigend zurück.

Request Body

{ "assetId": "uuid", "sourceType": "RealtimeAction", "sourceId": "string", "userId": "uuid", "since": "2026-01-01T00:00:00Z", "page": 1, "pageSize": 50 }

Erforderlich: since (nur Einträge ab diesem Zeitpunkt zurückgeben). Zusätzlich muss entweder assetId oder sourceType (oder beides) angegeben werden. sourceId filtert innerhalb eines angegebenen sourceType und ist nur zusammen mit sourceType gültig; ohne sourceType antwortet der Server mit 400. page hat den Standardwert 1 und pageSize den Standardwert 50 (maximal 500). Du kannst die Ergebnisse außerdem mit severity und einer Freitext-search einschränken sowie die Sortierung über sortBy (Timestamp oder SourceType) und sortDir (Asc oder Desc) steuern. Die vollständige Feldliste und die Typen findest du in Swagger.

Quelltypen

sourceType ist einer aus einer festen Menge von Werten (siehe Swagger), die jeweils für eine andere Art von Aktivität geschrieben werden:

  • RealtimeAction — ein Benutzer startet, stoppt oder startet einen Dienst neu bzw. beendet einen Prozess auf einem Gerät.
  • DirectSession — eine Terminal-Sitzung wird auf einem Gerät geöffnet oder geschlossen.
  • Task — ein automatisierter Task wird auf dem Gerät ausgeführt.
  • WindowsPatchManagement — Windows-Patch-Aktivität auf dem Gerät.
  • MacOSPatchManagement — macOS-Patch-Aktivität auf dem Gerät.
  • SoftwareDeploymentSoftware-Deployment-Aktivität auf dem Gerät.
  • Configuration — Konfigurations- und Automatisierungsaktivität auf dem Gerät.

Antwort

{ "items": [ { "id": "uuid", "assetId": "uuid", "timestamp": "2026-04-06T10:00:00Z", "severity": "Info", "content": "Opened Terminal session abc-123.", "userId": "user-uuid", "userName": "Alice Example", "source": { "id": "session-abc-123", "sourceType": "DirectSession" } } ], "total": 123 }

Gibt ein seitenweises Ergebnis zurück. items enthält die Protokolleinträge der angeforderten Seite (standardmäßig nach Zeitstempel absteigend sortiert), und total ist die Gesamtzahl der übereinstimmenden Einträge über alle Seiten hinweg. Wichtige Felder:

  • severity ist einer der Werte Info, Warning oder Error.
  • userId / userName sind null, wenn das Ereignis keinen ausführenden Benutzer hatte; userName ist der Anzeigename, der zum Zeitpunkt des Schreibens des Eintrags erfasst wurde, nicht der aktuelle Name des Benutzers.
  • source.id ist der Bezeichner des ursprünglichen Quellobjekts (zum Beispiel eine Patch-, Task- oder Sitzungs-ID), nicht der ausführende Benutzer.