API-Referenz

Betreut von: Aether365 Team Zielgruppe: Entwickler und DevOps-Ingenieure Umfang: Überblick über die Aether365 REST API, Basis-URL und Antwortformat

Die Aether365 API ermöglicht Ihnen den programmgesteuerten Zugriff auf Scandaten, das Auslösen von Scans, die Verwaltung von Tenants und die Steuerung von AI Pilot: automatisierte Remediation generieren, prüfen und anwenden, Signale zu Identitätsrisiken lesen und Richtlinien härten.

Endpunktgruppen

Bereich	Was er abdeckt
Scans	Compliance- und Exposure-Scans auslösen und auflisten
Results	Einzelne Scan-Befunde lesen
AI Pilot	Automatisierte Remediation-Pläne generieren, prüfen und anwenden
Threat Alerts	Signale zu Identitätsrisiken und Benutzer-Eindämmung per Klick
Policies	Richtlinien-Status lesen und freigegebene Richtlinien härten
Tenants	Tenant-Profil lesen und aktualisieren
Connections	Verbundene Microsoft 365-Tenants verwalten
Scheduled Scans	Wiederkehrende Scans automatisieren

Basis-URL

https://api.aether365.io

Alle Endpunkte sind relativ zu dieser Basis-URL.

Authentifizierung

Die API verwendet Bearer-Token-Authentifizierung. Fügen Sie ein gültiges JWT-Token im Authorization-Header jeder Anfrage ein:

Authorization: Bearer <token>

Tokens werden vom Aether365-Authentifizierungssystem ausgestellt. Siehe Authentifizierung für Details zur Beschaffung eines Tokens.

Antwortformat

Alle API-Antworten verwenden eine einheitliche JSON-Struktur.

Erfolgsantwort

{
  "success": true,
  "data": {}
}

Für Listen-Endpunkte:

{
  "success": true,
  "data": [],
  "meta": {
    "total": 142,
    "page": 1,
    "limit": 20
  }
}

Für Aktions-Endpunkte (Auslösen, Löschen):

{
  "success": true,
  "data": null
}

Fehlerantwort

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Menschenlesbare Beschreibung",
    "details": {}
  }
}

HTTP-Statuscodes

Code	Bedeutung
200	Erfolg
201	Ressource erstellt
400	Ungültige Anfrage - fehlende oder fehlerhafte Parameter
401	Authentifizierung erforderlich oder Token ungültig
403	Zugriff verweigert - Tenant-Isolierungsverletzung
404	Ressource nicht gefunden
409	Konflikt - zum Beispiel läuft bereits ein Scan
429	Plan-Limit erreicht
500	Interner Serverfehler

Fehlercodes

Code	Beschreibung
AUTH_MISSING_TOKEN	Authorization-Header nicht vorhanden
AUTH_INVALID_TOKEN	Token konnte nicht verifiziert werden
AUTH_EXPIRED_TOKEN	Token ist abgelaufen
TENANT_NOT_FOUND	Tenant existiert nicht
TENANT_NOT_CONNECTED	Microsoft Consent nicht abgeschlossen
SCAN_NOT_FOUND	Scan-ID existiert nicht
SCAN_ALREADY_RUNNING	Ein Scan läuft bereits für diesen Tenant
SCAN_PLAN_LIMIT_REACHED	Scan-Kontingent für den aktuellen Plan erschöpft
VALIDATION_ERROR	Anfragekörper oder Abfrageparameter sind ungültig
INTERNAL_ERROR	Unerwarteter Serverfehler

Ratenlimits

Die API ist auf 120 Anfragen pro Minute begrenzt. Bei Überschreitung des Ratenlimits wird 429 Too Many Requests zurückgegeben. Der Retry-After-Header gibt an, wie viele Sekunden vor dem erneuten Versuch gewartet werden soll.