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

format parameter
Структура вместо текста

Каждую страницу монитора можно получить структурой: параметр format=xml или format=json на адресе без суффикса /ui. Корень монитора по умолчанию перенаправляет браузер на /ui.

Структуры XML и JSON совпадают поле в поле — руководство приводит ответ состояния в обоих форматах, — так что читающая сторона берёт удобный ей.

Главная ловушка — адрес с /ui. Скопированная из браузера ссылка ведёт на страницу для человека: разбор получит разметку вместо структуры.
Что делает Хаб. Просит json — так ответ разбирается без разбора текста.
Рекомендуемые значения

Кому какой адрес:

Кому Адрес Формат
человеку с /ui страница
программе на XML без /ui, format=xml XML
программе на JSON без /ui, format=json JSON
Адрес без /ui, два формата и совпадение структур — из руководства (§ 5.1, § 5.3). Таблица — наша.
Пример в конфигурации
# одна страница двумя форматами
curl -s 'http://127.0.0.1:8080/status?format=json'curl -s 'http://127.0.0.1:8080/status?format=xml'
Оба ответа несут одни и те же поля.
жёлтым — — имена директив, голубым — блоки. Так же они подсвечены и в тексте карточки.
Совместимость
PowerMTA 6.0
описана в руководстве этой версии · платформа: любая
С какой версии директива доступна, вендор указывает не для всех — здесь пометки нет. Имя встречается и в издании руководства 5.0.
Как проверить на узле
Проверить, что приходит структура:
curl -s 'http://127.0.0.1:8080/status?format=json' | head -c 200
Ответ должен начинаться с {; разметка HTML — запрос ушёл на страницу для человека.
В Хабе
Цена ошибки
безопасно: неверное значение ничего не ломает
Сценарии
Собрать телеметрию