Seminar Detectify Developer API – Automatisierung und Reporting

Das Seminar vermittelt den sicheren und robusten Einsatz der Detectify Developer API. API v2 und v3, Authentisierung, Asset- und Scanverwaltung, Findings, Angriffsflächendaten, Pagination, Fehlerbehandlung und Reporting werden zu wiederholbaren Automatisierungsabläufen verbunden.

Inhaltsübersicht

• Lernziele und fachliche Einordnung
• Schrittweise Seminarinhalte
• Praxisübungen und Laborszenarien
• Zielgruppe und Voraussetzungen
• Didaktik und Arbeitsweise

Lernziele

• API v2 und v3 nach Anwendungsfall und Datenbereich korrekt auswählen.
• API-Schlüssel sicher verwalten und minimal berechtigte Dienstidentitäten etablieren.
• Assets, Scanprofile und Scanläufe programmatisch steuern.
• Findings und Angriffsflächendaten zuverlässig exportieren und korrelieren.
• Idempotenz, Pagination, Rate Limits, Retries, Logging und Reporting produktionsreif umsetzen.

Schrittweise Seminarinhalte

1. API-Architektur, Versionen und Use Cases

Schwerpunkt: API v2, API v3, Ressourcenmodelle, Base Paths, Assets, Scans, Findings, Ports, Technologien, Connectoren und Zielsysteme.

1. Ausgangslage, Schutzbedarf und messbare Zielkriterien für den Themenblock „API-Architektur, Versionen und Use Cases“ erfassen.
2. Relevante Objekte, Rollen, Datenflüsse und Abhängigkeiten anhand von API v2, API v3, Ressourcenmodelle, Base Paths, Assets, Scans, Findings, Ports, Technologien, Connectoren und Zielsysteme modellieren.
3. Die erforderliche Konfiguration beziehungsweise Prozessfolge im Laborsystem schrittweise umsetzen und jeden sicherheitsrelevanten Zwischenschritt protokollieren.
4. Funktion, Berechtigungen, Abdeckung, Protokollierung und Fehlerverhalten mit definierten Positiv-, Negativ- und Grenzfällen prüfen.
5. Als Arbeitsergebnis eine API- und Integrationsentscheidungsmatrix dokumentieren, fachlich abnehmen und in einen wiederholbaren Standard überführen.

2. Authentisierung und Schlüsselgovernance

Schwerpunkt: API Key, Header, Secret Store, Rollen, Rotation, Sperrung, Umgebungen, Protokollierung und Notfallwechsel.

1. Ausgangslage, Schutzbedarf und messbare Zielkriterien für den Themenblock „Authentisierung und Schlüsselgovernance“ erfassen.
2. Relevante Objekte, Rollen, Datenflüsse und Abhängigkeiten anhand von API Key, Header, Secret Store, Rollen, Rotation, Sperrung, Umgebungen, Protokollierung und Notfallwechsel modellieren.
3. Die erforderliche Konfiguration beziehungsweise Prozessfolge im Laborsystem schrittweise umsetzen und jeden sicherheitsrelevanten Zwischenschritt protokollieren.
4. Funktion, Berechtigungen, Abdeckung, Protokollierung und Fehlerverhalten mit definierten Positiv-, Negativ- und Grenzfällen prüfen.
5. Als Arbeitsergebnis einen sicheren API-Schlüssel-Lifecycle dokumentieren, fachlich abnehmen und in einen wiederholbaren Standard überführen.

3. Assets und Scanprofile verwalten

Schwerpunkt: Assetlisten, IDs, Teams, Profile, Scope, Einstellungen, Anlage, Änderung, Abgleich und Deaktivierung.

1. Ausgangslage, Schutzbedarf und messbare Zielkriterien für den Themenblock „Assets und Scanprofile verwalten“ erfassen.
2. Relevante Objekte, Rollen, Datenflüsse und Abhängigkeiten anhand von Assetlisten, IDs, Teams, Profile, Scope, Einstellungen, Anlage, Änderung, Abgleich und Deaktivierung modellieren.
3. Die erforderliche Konfiguration beziehungsweise Prozessfolge im Laborsystem schrittweise umsetzen und jeden sicherheitsrelevanten Zwischenschritt protokollieren.
4. Funktion, Berechtigungen, Abdeckung, Protokollierung und Fehlerverhalten mit definierten Positiv-, Negativ- und Grenzfällen prüfen.
5. Als Arbeitsergebnis einen idempotenten Asset- und Profilabgleich dokumentieren, fachlich abnehmen und in einen wiederholbaren Standard überführen.

4. Scans auslösen und überwachen

Schwerpunkt: Trigger, Scheduling, Status, Warteschlange, Polling, Timeout, Abbruch, Korrelation und parallele Ausführung.

1. Ausgangslage, Schutzbedarf und messbare Zielkriterien für den Themenblock „Scans auslösen und überwachen“ erfassen.
2. Relevante Objekte, Rollen, Datenflüsse und Abhängigkeiten anhand von Trigger, Scheduling, Status, Warteschlange, Polling, Timeout, Abbruch, Korrelation und parallele Ausführung modellieren.
3. Die erforderliche Konfiguration beziehungsweise Prozessfolge im Laborsystem schrittweise umsetzen und jeden sicherheitsrelevanten Zwischenschritt protokollieren.
4. Funktion, Berechtigungen, Abdeckung, Protokollierung und Fehlerverhalten mit definierten Positiv-, Negativ- und Grenzfällen prüfen.
5. Als Arbeitsergebnis einen robusten automatisierten Scansteuerungsprozess dokumentieren, fachlich abnehmen und in einen wiederholbaren Standard überführen.

5. Findings exportieren und verarbeiten

Schwerpunkt: Filter, Schweregrad, Status, Proof of Concept, Pagination, Deduplizierung, Statusänderung, Retest und Deltaexport.

1. Ausgangslage, Schutzbedarf und messbare Zielkriterien für den Themenblock „Findings exportieren und verarbeiten“ erfassen.
2. Relevante Objekte, Rollen, Datenflüsse und Abhängigkeiten anhand von Filter, Schweregrad, Status, Proof of Concept, Pagination, Deduplizierung, Statusänderung, Retest und Deltaexport modellieren.
3. Die erforderliche Konfiguration beziehungsweise Prozessfolge im Laborsystem schrittweise umsetzen und jeden sicherheitsrelevanten Zwischenschritt protokollieren.
4. Funktion, Berechtigungen, Abdeckung, Protokollierung und Fehlerverhalten mit definierten Positiv-, Negativ- und Grenzfällen prüfen.
5. Als Arbeitsergebnis eine konsistente Finding-Export- und Synchronisationslogik dokumentieren, fachlich abnehmen und in einen wiederholbaren Standard überführen.

6. Attack-Surface-Daten mit API v3

Schwerpunkt: IP-Adressen, Ports, Technologien, Policy Breaches, Monitoring-Einstellungen, Connectoren, Änderungen und Zeitreihen.

1. Ausgangslage, Schutzbedarf und messbare Zielkriterien für den Themenblock „Attack-Surface-Daten mit API v3“ erfassen.
2. Relevante Objekte, Rollen, Datenflüsse und Abhängigkeiten anhand von IP-Adressen, Ports, Technologien, Policy Breaches, Monitoring-Einstellungen, Connectoren, Änderungen und Zeitreihen modellieren.
3. Die erforderliche Konfiguration beziehungsweise Prozessfolge im Laborsystem schrittweise umsetzen und jeden sicherheitsrelevanten Zwischenschritt protokollieren.
4. Funktion, Berechtigungen, Abdeckung, Protokollierung und Fehlerverhalten mit definierten Positiv-, Negativ- und Grenzfällen prüfen.
5. Als Arbeitsergebnis einen automatisierten Angriffsflächen- und Änderungsdatenstrom dokumentieren, fachlich abnehmen und in einen wiederholbaren Standard überführen.

7. Fehlerbehandlung, Rate Limits und Observability

Schwerpunkt: HTTP-Fehler, Retries, Backoff, Idempotency, Teilzustände, Quotas, Auditlog, Metriken und Alarmierung.

1. Ausgangslage, Schutzbedarf und messbare Zielkriterien für den Themenblock „Fehlerbehandlung, Rate Limits und Observability“ erfassen.
2. Relevante Objekte, Rollen, Datenflüsse und Abhängigkeiten anhand von HTTP-Fehler, Retries, Backoff, Idempotency, Teilzustände, Quotas, Auditlog, Metriken und Alarmierung modellieren.
3. Die erforderliche Konfiguration beziehungsweise Prozessfolge im Laborsystem schrittweise umsetzen und jeden sicherheitsrelevanten Zwischenschritt protokollieren.
4. Funktion, Berechtigungen, Abdeckung, Protokollierung und Fehlerverhalten mit definierten Positiv-, Negativ- und Grenzfällen prüfen.
5. Als Arbeitsergebnis ein produktionsreifes Fehler- und Betriebsmodell dokumentieren, fachlich abnehmen und in einen wiederholbaren Standard überführen.

8. Reporting und Betriebsübergabe

Schwerpunkt: Datenmodell, Kennzahlen, Management- und Technikberichte, Zeitstempel, Nachvollziehbarkeit, Datenschutz, Runbook und Change.

1. Ausgangslage, Schutzbedarf und messbare Zielkriterien für den Themenblock „Reporting und Betriebsübergabe“ erfassen.
2. Relevante Objekte, Rollen, Datenflüsse und Abhängigkeiten anhand von Datenmodell, Kennzahlen, Management- und Technikberichte, Zeitstempel, Nachvollziehbarkeit, Datenschutz, Runbook und Change modellieren.
3. Die erforderliche Konfiguration beziehungsweise Prozessfolge im Laborsystem schrittweise umsetzen und jeden sicherheitsrelevanten Zwischenschritt protokollieren.
4. Funktion, Berechtigungen, Abdeckung, Protokollierung und Fehlerverhalten mit definierten Positiv-, Negativ- und Grenzfällen prüfen.
5. Als Arbeitsergebnis eine dokumentierte Reporting- und Automatisierungsreferenz dokumentieren, fachlich abnehmen und in einen wiederholbaren Standard überführen.

Praxisübungen und Laborszenarien

• Entwurf eines API-Schlüssel- und Rotationskonzepts für mehrere Automatisierungsdienste.
• Aufbau eines idempotenten Ablaufs zur Abfrage von Assets und zum Start eines Scanprofils.
• Verarbeitung paginierter Findings mit Deltaerkennung und Fehlerwiederholung.
• Erstellung eines technischen Reportings aus Scan-, Finding-, Port- und Technologiedaten.

Zielgruppe und Voraussetzungen

Zielgruppe: Security Automation, DevSecOps, AppSec Engineering, Plattformintegration, Reporting, SIEM-Engineering und technische Entwicklung.

Voraussetzungen: REST-, JSON- und Skripting-Grundkenntnisse; Erfahrung mit API-Schlüsseln, HTTP-Statuscodes und automatisierten Workflows.

Didaktik und Arbeitsweise

Fachimpulse, Demonstrationen und geführte Konfigurationsschritte wechseln mit Praxisübungen, kontrollierten Fehlerfällen und Reviewphasen. Jede Übung verwendet definierte Ausgangswerte, Prüfpunkte und Dokumentationsanforderungen, damit die Abläufe wiederholbar bleiben.