Полный перечень всех команд «Апдейтера» есть в SWAGGER-документации, которая доступна по адресу http://updaterHost:port/swagger/index.html
Текущая спецификация в JSON — swagger.json
Для взаимодействия с «Апдейтером» рекомендуем использовать SWAGGER или приложения для работы с API (например Postman, SoapUI).
Ниже команды для консоли указаны лишь в качестве универсального примера.
Основные команды
Описание | Команда для консоли (в примерах умолчательный порт 3000, и запросы выполняются с сервера Апдейтера) | Авторизация (включена если в updater.yaml задан http_auth, тогда к запросам добавляется |
Получить версию «Апдейтера» и приложений. | curl -X GET http://localhost:3000/info/version | всегда доступен |
Перечитать и обновить текущие файлы конфигурации приложения | curl -X PATCH http://localhost:3000/info/config | |
Получить историю вызовов Апдейтера за весь период (или N последних дней) | curl -X GET http://localhost:3000/info/ history | |
Скачать и обновить справочник. В примере справочника адресов |
|
|
Скачать справочник. В примере справочника адресов |
| |
Добавить задачу в расписание. В примере настройка расписания для скачивания и обновления справочника банков в «Подсказках». |
| |
Получить список задач. | curl -X GET http://localhost:3000/schedule | |
Удалить задачу из расписания. | curl -X 'DELETE' http://localhost:3000/schedule/{scheduleId} |