Порт подключения к API
По умолчанию по умолчанию 6015/TCP можно изменить в интерфейсе.
После изменения, необходимо переподключить API
Авторизация API
для авторизации используется заголовок: X-API-KEY
API принимает заголовок X-API-KEY в виде GET параметра, либо как кастомный заголовок.
Пример:
http://127.0.0.1:6015/play/CCD142CE-0AB5-4492-A9F7-762019803C96?X-API-KEY=15A692A4-DDEC-4DE4-8DE9-2131062CF36BКоды ответов API
| Код | Описание |
| 200 | Доступен |
| 201 | Задача запущена |
| 400 | Ошибка в запросе |
| 401 | Требуется авторизация |
| 404 | Элемент задачи не найден |
| 405 | Метод не поддерживается |
| 423 | Целевой ресурс из запроса заблокирован от применения к нему указанного метода |
| 500 | Ошибка сервера |
| 503 | Команда не доступна |
Команды API
| Команда | Параметры | Дополнительные параметры | Описание |
| play | ID Плейбука | Запустить Плейбук по ID [GET] http://127.0.0.1:6015/play/CCD142CE-0AB5-4492-A9F7-762019803C96 | |
| state | live | Проверить доступность API. [GET] http://127.0.0.1:6015/state/live | |
| messages | start | EPS - установить значение EPS для задачи отправки. stoptime - Установить время выполнения задачи отправки. StopCount - Установить количество отправляемых событий, до остановки. | Запустить отправку событий с текущим профилем. [GET] http://127.0.0.1:6015/messages/start [GET] http://127.0.0.1:6015/messages/start?EPS=1000&stoptime=3600 [GET] http://127.0.0.1:6015/messages/start?EPS=1000 [GET] http://127.0.0.1:6015/messages/start?EPS=1000&stoptime=360&StopCount=100000 |
| messages | stop | Остановить отправку событий [GET] http://127.0.0.1:6015/messages/stop | |
| messages | eps | Вернуть текущий EPS [GET] http://127.0.0.1:6015/messages/eps | |
| messages | avg | Вернуть текущий средний EPS [GET] http://127.0.0.1:6015/messages/avg | |
| messages | state | Вернуть статус отправки (Активен/Не активен) [GET] http://127.0.0.1:6015/messages/state | |
| messages | set | eps - установить значение EPS для задачи отправки. stoptime - Установить время выполнения задачи отправки. stopcount - Установить количество отправляемых событий, до остановки. timeout - Установить таймаут между отправкой событий randomtimeout - использовать случайный тамаут (true/false) | Позволяет изменить параметры отправки событий в messages, не выполняя каких либо действий. [GET] http://127.0.0.1:6015/messages/set?eps=100&stoptime=5&stopcount=1000 [GET] http://127.0.0.1:6015/messages/set?timeou=1&randomtimeou=true |
| sender | message - Сообщение для отправки (обязательный параметр) host - Установить хост port - Установить порт proto - Выбрать протокол (из списка достпуных) index - Установить параметр Index json - установить параметр отправки событий в формте json (true/false) | [GET] /sender?message=<message>&proto=udp&index=test2&json=false | |
| version | build | Вернуть номер сборки [GET] http://127.0.0.1:6015/vesion/build | |
| version | app | Получить версию приложения [GET] http://127.0.0.1:6015/vesion/app |