Zum Inhalt

Zugang zum Endpoint und Authentifizierung

Um auf einen Endpoint der Export-API zuzugreifen, müssen Sie sich mit einem gültigen API-Token authentifizieren. Ein Tenant-Administrator generiert dieses Token, wie im Abschnitt Zugangstoken generieren beschrieben.

Session-Management

Zur Authentifizierung über die Swagger-Benutzeroberfläche:

  1. Öffnen Sie die Schnittstelle Swagger UI: Export Gateway API
  2. Klicken Sie in der oberen rechten Ecke auf den Button Authorize. Es erscheint ein Pop-up-Fenster mit einem Feld mit der Bezeichnung Authorization.
  3. Geben Sie Ihr Token in folgendem Format ein:
    Bearer your_token_here
  1. Bestätigen Sie mit Authorize. Wenn Sie erfolgreich waren, können Sie nun die Endpoints direkt testen.
  2. Verwenden Sie den Button Logout, um das Token zu entfernen oder zu ersetzen.

Solange das System autorisiert ist, sendet es das Bearer-Token mit jeder API-Anfrage im Authorization Header.

Note

Das Bearer-Token bleibt aktiv, bis:

  • Es sein Ablaufdatum erreicht
  • Sie es manuell widerrufen
  • Ihre Rollenberechtigungen oder der Tenant-Zugang sich ändern.

Verfügbare Endpoint-Gruppen

Die Export-API ermöglicht Zugang zu sechs primären Datenkategorien:

Gruppe Endpoint(s) Beschreibung
octoplant Server /octoplantservers Ruft Informationen über octoplant Server ab
Asset-Informationen /assetinformation Ruft Asset-Metadaten für bestimmte oder alle Server ab
Komponenten /componentinformation Ruft Informationen über Software- und Hardwarekomponenten ab
Jobs /jobs;/jobresults Ruft die Jobkonfigurationen pro Server und die Ergebnisse der ausgeführten Jobs ab
Logs /adminlogs;/componentlogs;/eventlogs Ruft Einträge aus Admin-, Komponenten- und Ereignislogs ab
CVEs /cves;/cves/{cveId}/impact Auffinden allgemeiner Schwachstellen und Gefährdungen im Zusammenhang mit Systemressourcen
Authentifizierung /createtoken Validiert einen API-Schlüssel und erzeugt ein Bearer-Token für den authentifizierten Zugriff

Jeder Endpoint unterstützt optionale Filter wie server_ids, component_key, Paginierungssteuerungen und ggf. Sortieroptionen.

Beispielanfrage

    GET /components?page_size=10&page_number=1&sort_order=asc&sort_field=server_id
    Authorization: Bearer <your_token_here>

Diese Anfrage enthält allgemeine Abfrageparameter:

    /components:
    get:
        summary: Get component information
        parameters:
        - page_size
        - page_number
        - sort_order
        - sort_field

Note

Die vollständige API-Spezifikation finden Sie unter Export Gateway API specification

Best Practices

  • Verwenden Sie die Paginierung für große Datensätze.
  • Verwenden Sie Abfrageparameter, um nach Server- oder Komponenten-Schlüssel zu filtern, wenn möglich.