API для выгрузки логов в S3/SFTP $

Описание

В этом разделе описаны методы API для настройки выгрузки сырых логов в ваше хранилище S3 или SFTP.

Успешные ответы и ошибки валидации возвращаются в формате JSON.

Внимание!

Для аккаунта настраивается одно хранилище — S3 или SFTP. Если услуга не подключена, сохранить или включить выгрузку нельзя — будет получен ответ со статус-кодом 402.
При сохранении настроек проверяется доступ к хранилищу: в него загружается пустой файл test.txt (в S3 — в корень бакета, в SFTP — в папку folder или в домашнюю директорию пользователя), после чего файл удаляется. Если такой файл уже есть, он будет перезаписан и удалён.
Ответы API содержат параметры доступа к хранилищу, включая пароль и секретный ключ.

Логи выгружаются отдельными файлами, каждый файл — за интервал длиной period минут. Интервалы отсчитываются от начала часа по UTC.

Путь к файлу формируется по времени окончания интервала (UTC), числа указываются без ведущих нулей:

<год>/<месяц>/<день>/<час>/<минута>.log.gz

Пример пути к файлу за интервал 29.10.2026 07:00–08:00 UTC (period: 60):

2026/10/29/8/0.log.gz

Пример пути к файлу за интервал 29.10.2026 07:00–07:05 UTC (period: 5):

2026/10/29/7/5.log.gz

Файл — gzip-архив с лог-файлом, формат лог-файла описан в разделе Описание лог-файла
Файл за интервал выгружается примерно через час после окончания интервала, первые файлы после включения выгрузки появляются примерно через 1–2 часа
Если за интервал запросов не было, выгружается файл без записей
В S3 файлы сохраняются от корня бакета, в SFTP — в папку folder или в домашнюю директорию пользователя, если папка не указана. Недостающие директории создаются автоматически
Новый интервал выгрузки начинает действовать со следующего часа
Если файл не удалось загрузить в хранилище, выгрузка повторяется автоматически, а в поле status возвращается fail
Логи за время, когда выгрузка была выключена или услуга не была оплачена, не выгружаются. Их можно получить через API для получения лог-файла