Αναφορά API
Maintained by: Aether365 Team Audience: Developers and DevOps engineers Scope: Aether365 REST API overview, base URL, and response format
Το API του Aether365 σας επιτρέπει να αποκτάτε πρόσβαση σε δεδομένα σαρώσεων, να εκκινείτε σαρώσεις, να διαχειρίζεστε tenants και να καθοδηγείτε το AI Pilot μέσω προγραμματισμού - δημιουργώντας, αξιολογώντας και εφαρμόζοντας αυτοματοποιημένες αποκαταστάσεις, διαβάζοντας σήματα κινδύνου ταυτότητας και θωρακίζοντας πολιτικές.
Endpoint groups
| Περιοχή | Τι καλύπτει |
|---|---|
| Σαρώσεις | Εκκίνηση και λίστα σαρώσεων συμμόρφωσης και έκθεσης |
| Αποτελέσματα | Ανάγνωση μεμονωμένων ευρημάτων σάρωσης |
| AI Pilot | Δημιουργία, αξιολόγηση και εφαρμογή αυτοματοποιημένων σχεδίων αποκατάστασης |
| Threat Alerts | Σήματα κινδύνου ταυτότητας και περιορισμός χρήστη με ένα κλικ |
| Πολιτικές | Ανάγνωση της κατάστασης πολιτικών και θωράκιση πολιτικών από λίστα επιτρεπόμενων |
| Tenants | Ανάγνωση και ενημέρωση του προφίλ tenant |
| Συνδέσεις | Διαχείριση συνδεδεμένων tenants Microsoft 365 |
| Προγραμματισμένες Σαρώσεις | Αυτοματοποίηση επαναλαμβανόμενων σαρώσεων |
Base URL
https://api.aether365.ioΟλα τα endpoints είναι σχετικά με αυτό το base URL.
Πιστοποίηση
Το API χρησιμοποιεί Bearer token authentication. Συμπεριλάβετε ένα έγκυρο JWT token στο header Authorization κάθε αιτήματος:
Authorization: Bearer <token>Τα tokens εκδίδονται από το σύστημα πιστοποίησης του Aether365. Δείτε Πιστοποίηση για λεπτομέρειες σχετικά με την απόκτηση token.
Μορφή Απαντήσεων
Ολες οι απαντήσεις του API χρησιμοποιούν μια ενιαία δομή JSON.
Επιτυχής Απάντηση
json
{
"success": true,
"data": {}
}Για endpoints λίστας:
json
{
"success": true,
"data": [],
"meta": {
"total": 142,
"page": 1,
"limit": 20
}
}Για endpoints ενεργειών (trigger, delete):
json
{
"success": true,
"data": null
}Απάντηση Σφάλματος
json
{
"success": false,
"error": {
"code": "ERROR_CODE",
"message": "Human-readable description",
"details": {}
}
}Κωδικοί Κατάστασης HTTP
| Κωδικός | Σημασία |
|---|---|
200 | Επιτυχία |
201 | Δημιουργήθηκε πόρος |
400 | Μη έγκυρο αίτημα - λείπουν ή εσφαλμένες παράμετροι |
401 | Απαιτείται πιστοποίηση ή μη έγκυρο token |
403 | Απαγόρευση πρόσβασης - παραβίαση απομόνωσης tenant |
404 | Ο πόρος δεν βρέθηκε |
409 | Σύγκρουση - για παράδειγμα, μια σάρωση εκτελείται ήδη |
429 | Ξεπεράστηκε το όριο πλάνου |
500 | Εσωτερικό σφάλμα διακομιστή |
Κωδικοί Σφαλμάτων
| Κωδικός | Περιγραφή |
|---|---|
AUTH_MISSING_TOKEN | Δεν υπάρχει header Authorization |
AUTH_INVALID_TOKEN | Το token δεν μπόρεσε να επαληθευτεί |
AUTH_EXPIRED_TOKEN | Το token έχει λήξει |
TENANT_NOT_FOUND | Το tenant δεν υπάρχει |
TENANT_NOT_CONNECTED | Η συναίνεση Microsoft δεν ολοκληρώθηκε |
SCAN_NOT_FOUND | Δεν υπάρχει σάρωση με αυτό το ID |
SCAN_ALREADY_RUNNING | Μια σάρωση εκτελείται ήδη για αυτό το tenant |
SCAN_PLAN_LIMIT_REACHED | Η ποσόστωση σαρώσεων εξαντλήθηκε για το τρέχον πλάνο |
VALIDATION_ERROR | Μη έγκυρο σώμα αιτήματος ή παράμετροι ερωτήματος |
INTERNAL_ERROR | Μη αναμενόμενο σφάλμα διακομιστή |
Ορια Ρυθμού
Το API έχει όριο 120 αιτημάτων ανά λεπτό. Υπέρβαση του ορίου επιστρέφει 429 Too Many Requests. Το header Retry-After δείχνει πόσα δευτερόλεπτα πρέπει να περιμένετε πριν επαναλάβετε.