API справочник

Aether365 API ви позволява програмен достъп до данни от сканирания, стартиране на сканирания, управление на tenant-и и управление на AI Pilot: генериране, преглед и прилагане на автоматизирано отстраняване, четене на сигнали за риск за идентичността и подсилване на политики.

Групи крайни точки

Област	Какво обхваща
Scans	Стартиране и изброяване на сканирания за съответствие и експозиция
Results	Четене на отделни констатации от сканиране
AI Pilot	Генериране, преглед и прилагане на планове за автоматизирано отстраняване
Threat Alerts	Сигнали за риск за идентичността и ограничаване на потребител с едно кликване
Policies	Четене на състоянието на политиките и подсилване на политики от списъка с разрешени
Tenants	Четене и актуализиране на профила на tenant-а
Connections	Управление на свързаните Microsoft 365 tenant-и
Scheduled Scans	Автоматизиране на повтарящи се сканирания

Базов URL

https://api.aether365.io

Всички крайни точки са относителни спрямо този базов URL.

Удостоверяване

API използва Bearer token удостоверяване. Включете валиден JWT токен в заглавието Authorization на всяка заявка:

Authorization: Bearer <token>

Токените се издават от системата за удостоверяване на Aether365. Вижте Удостоверяване за детайли как да получите токен.

Формат на отговорите

Всички API отговори използват единна JSON структура.

Успешен отговор

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

За крайни точки с листинг:

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

За крайни точки за действия (стартиране, изтриване):

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

Отговор с грешка

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable description",
    "details": {}
  }
}

HTTP статус кодове

Код	Значение
200	Успех
201	Ресурсът е създаден
400	Невалидна заявка - липсващи или неправилни параметри
401	Изисква се удостоверяване или токенът е невалиден
403	Достъпът е отказан - нарушение на изолацията на tenant-и
404	Ресурсът не е намерен
409	Конфликт - например сканиране вече е в ход
429	Лимитът на плана е достигнат
500	Вътрешна сървърна грешка

Кодове за грешка

Код	Описание
AUTH_MISSING_TOKEN	Заглавието Authorization не е налично
AUTH_INVALID_TOKEN	Токенът не може да бъде проверен
AUTH_EXPIRED_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. Заглавието Retry-After показва колко секунди да изчакате преди повторен опит.