reports.php¶

В этой статье

Методы API

reports/abusedb

reports/active_delays

reports/active_services

reports/add

reports/add_conversions

reports/asa_log

reports/billing_cycle_journal

reports/billing_sync

reports/bm_ip

reports/clone

reports/count_software_installs

reports/create_preset_reports

reports/delete

reports/deploy

reports/deploy_journal

reports/deploy_journal_update

reports/deploy_stall_list

reports/employees

reports/execute

reports/execute_all

reports/export

reports/generate_daily

reports/get_convertions

reports/get_convertions_filter

reports/infra

reports/invoice_report

reports/licenses

reports/list

reports/managed_apps_deployed

reports/ovirt_ip

reports/pdu

reports/port_of_virt_node

reports/power_consumption

reports/presets_calculate_roi

reports/presets_get_roi

reports/presets_get_roi

reports/registrations

reports/show

reports/sms_log

reports/suspension_journal

reports/timetable

reports/tplatforms

reports/traffic_invoices

reports/traffic_usage

reports/update

reports/update_ltv

reports/update_racks_power

reports/user_control_locks

reports/vat_report

reports/whmcs_services

reports/windows_ip

reports/yookassa_refund_journal

reports/billing_cycle_journal_migrate

reports/get_data

reports/idle

reports/openstack_nodes

reports/ovirt_nodes

reports/try

Модуль отчетов администратора: мониторинг активности IP (AbuseDB), отчеты по трафику, инвойсы, реестры изменений биллинга и управление журналами развертывания.

Методы API¶

Метод	Действие	Описание
`abusedb`	запуск проверки IP через AbuseIPDB	Запускает процесс сканирования IP-адресов на предмет вредоносной активности (DDoS, Spam, Brute-Force и др.) с использованием внешнего API.
`active_delays`	получение списка активных задержек развертывания	Возвращает отчет по текущим задержкам (delays) в процессах деплоя, включая количество реинсталляций и лимиты.
`active_services`	получение отчета по активным сервисам и выручке	Возвращает список активных сервисов с данными о выручке. Поддерживает экспорт в CSV.
`add`	добавление записи в отчет	Добавляет новую запись в систему отчетов через передачу массива параметров.
`add_conversions`	добавление конверсий	Добавляет данные о конверсиях в систему отчетов.
`asa_log`	логирование ASA (Automated Security Action)	Сохраняет логи событий автоматической безопасности в журнал.
`billing_cycle_journal`	получение журнала изменений циклов биллинга	Возвращает список изменений в циклах оплаты (billing cycles) клиентов.
`billing_cycle_journal_migrate`	миграция журнала биллинга	Запускает процесс миграции старых данных журналов биллинга.
`billing_sync`	синхронизация биллинга	Запускает процесс синхронизации данных из WHMCS с локальной базой данных. Метод помечен как устаревший (Retired).
`bm_ip`	получение IP Bare Metal	Возвращает список IP-адресов для Bare Metal серверов в указанной локации.
`clone`	клонирование пресета/отчета	Создает копию существующего объекта (пресета или отчета).
`count_software_installs`	подсчет установок ПО	Метод помечен как Retired. Работа перенесена в планировщик.
`create_preset_reports`	инициализация пресетов	Инициализирует системные отчеты по шаблонам (presets).
`delete`	удаление отчета/пресета	Удаляет запись отчета или пресета по ID.
`deploy`	отчет по развертыванию	Возвращает отчет о развертывании (deployment report) с фильтрацией по локации, периоду и типам инфраструктуры.
`deploy_journal`	получение журнала развертывания	Возвращает список записей из журнала развертывания с данными о локации.
`deploy_journal_update`	обновление записи в журнале развертывания	Обновляет статус или детали записи в журнале развертывания (завершение задачи, назначение сотрудника и т.д.).
`deploy_stall_list`	получение списка задержек развертывания	Возвращает список записей о задержках (stalls) в процессе развертывания.
`employees`	получение списка сотрудников	Возвращает список сотрудников, входящих в команду текущего пользователя.
`execute`	выполнение команды	Выполняет команду (execution) для конкретного объекта.
`execute_all`	массовое выполнение	Запускает массовую задачу выполнения (например, генерация отчетов) с указанием количества итераций.
`export`	экспорт отчетов	Экспортирует данные в формате CSV на основе переданных строк и заголовков.
`generate_daily`	генерация ежедневного отчета	Запускает процесс генерации ежедневных отчетов для указанного ID.
`get_convertions`	получение конверсии	Получает данные по конверсиям с фильтрацией по UTM-меткам и датам.
`get_convertions_filter`	получение фильтров конверсии	Возвращает список доступных значений для фильтрации отчетов по UTM-меткам.
`get_data`	получение данных по ID	Возвращает детальные данные объекта (отчет) по его ID.
`idle`	отчет по неактивным серверам	Возвращает список серверов, которые находятся в режиме ожидания (не в fleet).
`infra`	инфраструктурный отчет	Возвращает отчет по состоянию инфраструктуры.
`invoice_report`	выгрузка CSV-отчета по инвойсам	Генерирует и отдает CSV-файл с детальной информацией по инвойсам за указанный период.
`licenses`	получение списка лицензий	Возвращает список лицензий с учетом фильтрации по семейству продуктов.
`list`	получение списка отчетов	Возвращает список доступных отчетов.
`managed_apps_deployed`	получение данных о развернутых приложениях	Возвращает отчет по установленным управляемым приложениям.
`openstack_nodes`	получение узлов OpenStack	Возвращает список узлов и сводную информацию по платформе OpenStack.
`ovirt_ip`	получение IP-адресов OVIRT	Возвращает список IP-адресов, связанных с виртуализацией OVIRT.
`ovirt_nodes`	получение узлов OVIRT	Возвращает список узлов и сводную информацию по платформе OVIRT.
`pdu`	получение данных PDU	Возвращает отчет по устройствам распределения питания (PDU) для указанной локации.
`port_of_virt_node`	получение портов виртуальных узлов	Возвращает список портов для виртуальных узлов в указанной локации.
`power_consumption`	получение энергопотребления	Возвращает отчет по энергопотреблению.
`presets_calculate_roi`	расчет ROI пресетов	Запускает процесс расчета окупаемости (ROI) для пресетов.
`presets_get_roi`	получение ROI пресетов	Возвращает данные о показателях ROI для пресетов.
`presets_get_roi`	получение ROI пресетов	Возвращает данные о показателях ROI для пресетов.
`registrations`	получение регистраций	Возвращает список регистраций (экспорт в CSV).
`show`	показать отчет	Возвращает детализированную информацию по конкретному отчету.
`sms_log`	получение лога SMS	Возвращает список записей журнала отправки SMS-сообщений с пагинацией.
`suspension_journal`	получение журнала приостановки услуг	Возвращает список записей журнала приостановки услуг с применением фильтрации.
`timetable`	получение расписания сотрудников	Возвращает график работы (таймлайн) сотрудника.
`tplatforms`	отчет по использованию платформ	Генерирует отчет использования T-платформ за указанный период.
`traffic_invoices`	отчет по трафику в инвойсах	Возвращает детализацию использования трафика, сгруппированную по валютам.
`traffic_usage`	отчет по использованию трафика	Возвращает отчет об использовании трафика серверами с возможностью шейпинга (ограничения).
`try`	тестовый запуск отчета	Выполняет пробный (test) запуск метода report_try с переданными параметрами.
`update`	обновление отчета	Обновляет данные в отчете по указанному ID с использованием переданных параметров.
`update_ltv`	обновление LTV	Запуск процесса обновления показателей LTV (Lifetime Value). Метод является устаревшим и вызывается по расписанию.
`update_racks_power`	обновление потребления стоек	Обновляет теги энергопотребления для стоек (среднее, теоретическое и максимальное значения) на основе текущих данных.
`user_control_locks`	получение блокировок управления пользователями	Возвращает список записей о блокировках/управлении пользователями.
`vat_report`	отчет по НДС (VAT)	Генерирует отчет по инвойсам с учетом налогов (VAT) для указанного региона и периода.
`whmcs_services`	сервисы WHMCS	Получает список сервисов из системы WHMCS для сверки с локальными данными.
`windows_ip`	IP адреса Windows	Возвращает список IP-адресов серверов с лицензионным ПО Windows для активации.
`yookassa_refund_journal`	получение журнала возвратов YooKassa	Возвращает список записей о возвратах через систему YooKassa за указанный период.

reports/abusedb¶

Запускает процесс сканирования IP-адресов на предмет вредоносной активности (DDoS, Spam, Brute-Force и др.) с использованием внешнего API.

HTTP-метод: GET

Параметры:

action	✅	string	Идентификатор метода: `abusedb`
token	✅	string	Токен авторизации администратора
data	✅	string	Параметр data
debug	❌	integer	Режим отладки для вывода подробной информации о процессе проверки IP-адресов.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X GET \
--data "action=abusedb" \
--data "token=HOSTKEY_TOKEN" \
--data "data=VALUE"

Пример успешного ответа

{
"result": "OK",
"module": "reports",
"action": "abusedb",
"total_blocks": 15,
"reports_sent": 3
}

Примеры ошибок

{
"code": -1,
"message": "Ошибка выполнения запроса к AbuseIPDB или ошибка базы данных"
}

reports/active_delays¶

Возвращает отчет по текущим задержкам (delays) в процессах деплоя, включая количество реинсталляций и лимиты.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `active_delays`
token	✅	string	Токен авторизации администратора
date_from	❌	string	Дата начала периода (формат Y-m-d H:i:s). По умолчанию - 30 дней назад.
date_to	❌	string	Дата окончания периода (формат Y-m-d H:i:s). По умолчанию - текущая дата.
from	❌	string	Дата начала периода с добавлением времени 00:00:00. Формируется из date_from или по умолчанию.
to	❌	string	Дата окончания периода с добавлением времени 23:59:59. Формируется из date_to или по умолчанию.
list	✅	string	Параметр `list`
limits	✅	string	Параметр `limits`

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=active_delays" \
--data "token=HOSTKEY_TOKEN" \
--data "list=VALUE" \
--data "limits=VALUE"

Пример успешного ответа

{
"result": "OK",
"module": null,
"action": "active_delays",
"data": {
"list": [],
"deploy_count": 120,
"reinstall_count": 5,
"limits": {}
}
}

Примеры ошибок

{
"code": -1,
"message": "Ошибка получения данных из журнала развертывания"
}

reports/active_services¶

Возвращает список активных сервисов с данными о выручке. Поддерживает экспорт в CSV.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `active_services`
token	✅	string	Токен авторизации администратора
filters_only	❌	integer	Если 1, возвращает только доступные фильтры для отчета.
format	❌	string	Формат вывода. Допустимые значения: csv

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=active_services" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"module": "unknown",
"action": "active_services",
"services": [
{
"id": 1024,
"name": "Service Name",
"status": "active",
"amount": 50.0,
"currency": "EUR"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Ошибка при формировании отчета по сервисам"
}

reports/add¶

Добавляет новую запись в систему отчетов через передачу массива параметров.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `add`
token	✅	string	Токен авторизации администратора
params	✅	`array<object>`	Массив данных для добавления в отчет.
params[data]	✅	`array<object>`	Массив данных для добавления в отчет.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=add" \
--data "token=HOSTKEY_TOKEN" \
--data "params[]=VALUE" \
--data "params[data][]=VALUE1" \
--data "params[data][]=VALUE2"

Пример успешного ответа

{
"result": "OK",
"module": "unknown",
"action": "add",
"report": {}
}

Примеры ошибок

{
"code": -1,
"message": "Ошибка при добавлении записи в отчет"
}

reports/add_conversions¶

Добавляет данные о конверсиях в систему отчетов.

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `add_conversions`
token	✅	string	Токен авторизации администратора
data	✅	`array<object>`	Данные для добавления конверсий.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=add_conversions" \
--data "token=HOSTKEY_TOKEN" \
--data "data[]={\"id\":123}" \
--data "data[]={\"id\":456}"

Пример успешного ответа

{
"result": "OK",
"action": "add_conversions",
"report": {}
}

Примеры ошибок

{
"code": -1,
"message": "invalid request, no data inside"
}

reports/asa_log¶

Сохраняет логи событий автоматической безопасности в журнал.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `asa_log`
token	✅	string	Токен авторизации администратора
message	❌	string	JSON-строка с данными события (action, username, ipinfo, ipexternal, message, ipinternal).
ipinternal	❌	string	Внутренний IP-адрес пользователя.
username	✅	string	Имя пользователя.
ipinfo	✅	string	Информация об IP-адресе (передается в формате JSON).
ipexternal	✅	string	Внешний IP-адрес пользователя.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=asa_log" \
--data "token=HOSTKEY_TOKEN" \
--data "username=VALUE" \
--data "ipinfo=VALUE" \
--data "ipexternal=VALUE"

Пример успешного ответа

{
"result": "OK",
"message": "JSON-строка с исходным сообщением"
}

Примеры ошибок

{
"code": -1,
"message": "Ошибка при сохранении лога ASA"
}

reports/billing_cycle_journal¶

Возвращает список изменений в циклах оплаты (billing cycles) клиентов.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `billing_cycle_journal`
token	✅	string	Токен авторизации администратора
billing	❌	string	Фильтр по биллингу.
customer_type	❌	string	Тип клиента для фильтрации.
date_from	❌	string	Дата начала периода.
date_to	❌	string	Дата окончания периода.
search	❌	string	Поисковый запрос по журналу.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=billing_cycle_journal" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"module": null,
"action": "billing_cycle_journal",
"data": [
{
"id": 501,
"customer_id": 123,
"old_cycle": "Monthly",
"new_cycle": "Annually",
"changed_at": "2024-05-20T10:00:00Z"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Ошибка при получении журнала изменений биллинга"
}

reports/billing_sync¶

Запускает процесс синхронизации данных из WHMCS с локальной базой данных. Метод помечен как устаревший (Retired).

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `billing_sync`
token	✅	string	Токен авторизации
location	❌	string	Локация для фильтрации серверов.
id	❌	integer	ID конкретного инвойса для отладочной синхронизации.
debug	❌	integer	Уровень детализации вывода в консоль/логи.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=billing_sync" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"log": [
{
"inv": {
"id": 123,
"costEUR": 50.0,
"reccuring": 50.0,
"discount": 0,
"next_duedate": "2024-12-31",
"currency": "EUR",
"billing_cycle": "Monthly"
},
"bill": {
"product_id": 5,
"amount": 50.0,
"billingcycle": "Monthly",
"currency_code": "EUR"
}
}
],
"records": 1
}

Примеры ошибок

{
"code": -1,
"message": "Ошибка при обработке сервиса в WHMCS"
}

reports/bm_ip¶

Возвращает список IP-адресов для Bare Metal серверов в указанной локации.

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `bm_ip`
token	✅	string	Токен авторизации
id	❌	integer	ID сервера.
location	❌	string	Локация (DC). По умолчанию 'all'.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X GET \
--data "action=bm_ip" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "bm_ip",
"data": [
{
"ip": "1.2.3.4",
"server_id": 10,
"location": "NL"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Ошибка получения данных IP"
}

reports/clone¶

Создает копию существующего объекта (пресета или отчета).

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: clone
token	✅	string	Токен авторизации
id	❌	integer	ID объекта для клонирования.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=clone" \
--data "token=HOSTKEY_TOKEN" \
--data "id=50"

Пример успешного ответа

{
"result": "OK",
"module": "unknown",
"action": "clone",
"report": {
"id": 50,
"name": "Cloned Report"
}
}

Примеры ошибок

{
"code": -1,
"message": "Объект не найден"
}

reports/count_software_installs¶

Метод помечен как Retired. Работа перенесена в планировщик.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `count_software_installs`
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=count_software_installs" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "count_software_installs"
}

Примеры ошибок

{
"code": -1,
"message": "Endpoint retired"
}

reports/create_preset_reports¶

Инициализирует системные отчеты по шаблонам (presets).

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `create_preset_reports`
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=create_preset_reports" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"module": "unknown",
"action": "create_preset_reports"
}

Примеры ошибок

{
"code": -1,
"message": "Ошибка инициализации"
}

reports/delete¶

Удаляет запись отчета или пресета по ID.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `delete`
token	✅	string	Токен авторизации
id	❌	integer	ID удаляемого объекта (может быть передан через POST или GET).

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=delete" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

Пример успешного ответа

{
"result": "OK",
"module": "reports",
"action": "delete",
"report": {
"id": 123,
"status": "deleted"
}
}

Примеры ошибок

{
"code": -1,
"message": "Не удалось удалить объект"
}

reports/deploy¶

Возвращает отчет о развертывании (deployment report) с фильтрацией по локации, периоду и типам инфраструктуры.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: deploy
token	✅	string	Токен авторизации
location	❌	string	Локация (DC). Если 'All', фильтр не применяется.
period_from	✅	string	Дата начала периода (формат Y-m-d). Обязательна для корректной работы.
period_to	✅	string	Дата окончания периода (формат Y-m-d). Обязательна для корректной работы.
billing	❌	string	Биллинг/Локация для фильтрации. Если 'All', фильтр не применяется.
types_in	❌	string	Типы инфраструктуры через запятую. Допустимые значения: BM, VM, S3, MS.
types	❌	`array<string>`	Список типов ресурсов для развертывания отчета (BM, VM, S3, MS).

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=deploy" \
--data "token=HOSTKEY_TOKEN" \
--data "period_from=2023-01-01" \
--data "period_to=2023-12-31" \
--data "types[]=BM" \
--data "types[]=VM"

Пример успешного ответа

{
"result": "OK",
"module": "reports",
"action": "deploy",
"report": [
{
"id": 123,
"location": "NL",
"engine": "KVM",
"engine_type": "Virtualization"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "$module/deploy: invalid dates"
}

reports/deploy_journal¶

Возвращает список записей из журнала развертывания с данными о локации.

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `deploy_journal`
token	✅	string	Токен авторизации
date_from	❌	string	Дата начала (преобразуется в формат с временем: YYYY-MM-DD 00:00:00).
date_to	❌	string	Дата окончания (преобразуется в формат с временем: YYYY-MM-DD 23:59:59).
from	✅	string	Параметр для формирования временной метки начала периода.
to	✅	string	Параметр для формирования временной метки окончания периода.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X GET \
--data "action=deploy_journal" \
--data "token=HOSTKEY_TOKEN" \
--data "from=VALUE" \
--data "to=VALUE"

Пример успешного ответа

{
"data": [
{
"engine": "ovirt",
"location": {
"engine_type": "string",
"dc_location": "string",
"location_id": 1,
"reg_zone_id": 1,
"short_location": "string"
}
}
]
}

Примеры ошибок

{
"code": -1,
"message": "invalid dates"
}

reports/deploy_journal_update¶

Обновляет статус или детали записи в журнале развертывания (завершение задачи, назначение сотрудника и т.д.).

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `deploy_journal_update`
token	✅	string	Токен авторизации
id	✅	integer	ID записи в журнале (из контекста запроса).
server_id	❌	integer	ID сервера.
ticket	❌	string	Номер тикета поддержки.
jira_ticket	❌	string	Номер Jira тикета.
config	❌	string	Конфигурация (JSON/String).
done	❌	integer	Флаг завершения задачи (1 - выполнено).
note	❌	string	Примечание к записи.
delete	❌	integer	Флаг удаления (1 - удалить).
bug_report	❌	integer	Флаг отчета об ошибке.
assign_to_user	❌	integer	ID пользователя для назначения (положительное - назначить себе, отрицательное - снять назначение).
mode	✅	string	Режим записи (берется из существующей записи в журнале).
assignee	✅	string	Исполнитель (email пользователя или пустая строка для снятия назначения).
ready	✅	string	Дата и время завершения задачи в формате Y-m-d H:i:s.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=deploy_journal_update" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "mode=some_mode" \
--data "assignee=user@example.com" \
--data "ready=2023-10-27 15:00:00"

Пример успешного ответа

{
"result": "OK",
"module": "deploy_journal",
"action": "deploy_journal_update"
}

Примеры ошибок

{
"code": -1,
"message": "Order is already assigned"
}

reports/deploy_stall_list¶

Возвращает список записей о задержках (stalls) в процессе развертывания.

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `deploy_stall_list`
token	✅	string	Токен авторизации
date_from	❌	string	Дата начала (преобразуется в формат с временем: YYYY-MM-DD 00:00:00).
date_to	❌	string	Дата окончания (преобразуется в формат с временем: YYYY-MM-DD 23:59:59).
from	✅	string	Дата начала в формате YYYY-MM-DD 00:00:00 (формируется из date_from).
to	✅	string	Дата окончания в формате YYYY-MM-DD 23:59:59 (формируется из date_to).

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=deploy_stall_list" \
--data "token=HOSTKEY_TOKEN" \
--data "from=2023-01-01 00:00:00" \
--data "to=2023-01-01 23:59:59"

Пример успешного ответа

{
"data": [
{
"id": 10,
"reason": "Timeout"
}
]
}

Примеры ошибок

{}

reports/employees¶

Возвращает список сотрудников, входящих в команду текущего пользователя.

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `employees`
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X GET \
--data "action=employees" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"employees": [
{
"id": 5,
"login": "admin",
"email": "admin@hostkey.com"
}
]
}

Примеры ошибок

{}

reports/execute¶

Выполняет команду (execution) для конкретного объекта.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: execute
token	✅	string	Токен авторизации
id	❌	integer	ID объекта для выполнения команды.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=execute" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

Пример успешного ответа

{
"result": "OK",
"module": "unknown",
"action": "execute",
"report": {}
}

Примеры ошибок

{}

reports/execute_all¶

Запускает массовую задачу выполнения (например, генерация отчетов) с указанием количества итераций.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `execute_all`
token	✅	string	Токен авторизации
start	❌	integer	Начальная точка (если 0, запускается генерация всех отчетов).
amount	❌	integer	Количество записей для обработки. По умолчанию 100.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=execute_all" \
--data "token=HOSTKEY_TOKEN" \
--data "start=0" \
--data "amount=100"

Пример успешного ответа

{
"result": "OK",
"module": "string",
"action": "execute_all",
"report": {},
"left": 50,
"done": 10
}

Примеры ошибок

{}

reports/export¶

Экспортирует данные в формате CSV на основе переданных строк и заголовков.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: export
rows	❌	`array<object>`	Данные для экспорта (JSON строка или массив)
header	❌	`array<string>`	Заголовки столбцов (JSON строка или массив)
format	❌	string	Формат экспорта. Допустимые значения: csv.
filename	❌	string	Имя файла для скачивания.
token	❌	string	Уникальный идентификатор сессии или токен авторизации для выполнения запроса.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=export" \
--data "rows=[{\"id\":1,\"name\":\"test\"}]" \
--data "header=[\"ID\",\"Name\"]" \
--data "format=csv" \
--data "filename=report.csv"

Пример успешного ответа

{
"result": "OK",
"action": "export",
"message": "Файл сформирован и отправлен в поток"
}

Примеры ошибок

{
"code": -1,
"message": "Ошибка парсинга JSON данных или заголовков"
}

reports/generate_daily¶

Запускает процесс генерации ежедневных отчетов для указанного ID.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `generate_daily`
id	❌	integer	ID объекта для генерации отчета.
token	❌	string	Уникальный идентификатор сессии для авторизации запроса.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=generate_daily" \
--data "id=123" \
--data "token=your_session_token"

Пример успешного ответа

{
"result": "OK"
}

Примеры ошибок

{
"code": -1,
"message": "Error"
}

reports/get_convertions¶

Получает данные по конверсиям с фильтрацией по UTM-меткам и датам.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_convertions`
utm_source	❌	string	Источник UTM. По умолчанию 'All'.
utm_medium	❌	string	Канал UTM. По умолчанию 'All'.
utm_campaign	❌	string	Кампания UTM. По умолчанию 'All'.
source_page	❌	string	Страница источника. По умолчанию 'All'.
date_from	❌	string	Дата начала (формат Y-m-d). По умолчанию 'All'.
date_to	❌	string	Дата окончания (формат Y-m-d). По умолчанию 'All'.
zero_ltv	❌	string	Фильтр по LTV. По умолчанию 'All'.
csv	❌	integer	Флаг экспорта в CSV (1 - экспорт). По умолчанию -1.
token	❌	string	Уникальный идентификатор сессии или токен авторизации для доступа к API.
billing	❌	string	Название биллинговой системы или идентификатор тарифного плана для формирования отчета.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=get_convertions" \
--data "utm_source=google" \
--data "date_from=2023-01-01"

Пример успешного ответа

{
"result": "OK",
"data": [
{
"id": 123,
"billing": "Monthly",
"account_id": 456,
"email": "user@example.com",
"active_since": "2023-01-01",
"ltv": 150.5,
"utm_source": "google",
"utm_medium": "cpc",
"utm_campaign": "summer_sale",
"source_page": "/landing",
"VisitorID": "vid_987",
"VisitorIDdate": "2023-05-10"
}
]
}

Примеры ошибок

[]

reports/get_convertions_filter¶

Возвращает список доступных значений для фильтрации отчетов по UTM-меткам.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_convertions_filter`
token	✅	string	Авторизационный токен пользователя

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=get_convertions_filter" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"data": {
"utm_source": [
"google",
"bing",
"direct"
],
"utm_medium": [
"cpc",
"email",
"social"
],
"utm_campaign": [
"promo1",
"promo2"
],
"source_page": [
"/home",
"/pricing"
]
}
}

Примеры ошибок

[]

reports/infra¶

Возвращает отчет по состоянию инфраструктуры.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `infra`
token	❌	string	Уникальный идентификатор сессии для авторизации запроса.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=infra"

Пример успешного ответа

{
"result": "OK",
"module": "unknown",
"action": "infra",
"servers": []
}

Примеры ошибок

[]

reports/invoice_report¶

Генерирует и отдает CSV-файл с детальной информацией по инвойсам за указанный период.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `invoice_report`
token	✅	string	Токен авторизации
billing	❌	string	Идентификатор биллинга для фильтрации отчета (если пусто — все)
period_from	❌	string	Дата начала периода формирования отчета
period_to	❌	string	Дата окончания периода формирования отчета
client_created_from	❌	string	Дата создания клиента (от)
client_created_to	❌	string	Дата создания клиента (до)

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=invoice_report" \
--data "token=HOSTKEY_TOKEN" \
--data "billing=123" \
--data "period_from=2023-01-01" \
--data "period_to=2023-12-31"

Пример успешного ответа

{
"result": "OK",
"action": "invoice_report"
}

Примеры ошибок

{
"code": -1,
"message": "Не удалось отправить CSV-отчет"
}

reports/licenses¶

Возвращает список лицензий с учетом фильтрации по семейству продуктов.

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `licenses`
token	✅	string	Токен авторизации
family	❌	string	Семейство лицензий (например, Windows)
location	❌	string	Местоположение или локация для фильтрации лицензий.
billing	❌	string	Параметры биллинга для формирования отчета по лицензиям.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=licenses" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"module": null,
"action": "licenses",
"licenses": [
{
"id": 123,
"client": "User Name",
"status": "active",
"expiry_date": "2025-12-31"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Ошибка получения лицензий"
}

reports/list¶

Возвращает список доступных отчетов.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `list`
token	✅	string	Токен авторизации
params[id]	❌	integer	Фильтр по ID отчета
params	✅	`array<string>`	Контейнер для параметров фильтрации (может быть массивом)

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=list" \
--data "token=HOSTKEY_TOKEN" \
--data "params[id]=1"

Пример успешного ответа

{
"result": "OK",
"module": "unknown",
"action": "list",
"reports": [
{
"id": 1,
"name": "Monthly Revenue Report"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Ошибка получения списка отчетов"
}

reports/managed_apps_deployed¶

Возвращает отчет по установленным управляемым приложениям.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `managed_apps_deployed`
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=managed_apps_deployed" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"module": null,
"action": "managed_apps_deployed",
"data": [
{
"app_name": "Nginx",
"count": 15,
"status": "active"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Ошибка получения данных"
}

reports/ovirt_ip¶

Возвращает список IP-адресов, связанных с виртуализацией OVIRT.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `ovirt_ip`
token	✅	string	Токен авторизации
location	❌	string	Местоположение или идентификатор локации для формирования отчета.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=ovirt_ip" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "ovirt_ip",
"data": [
{
"ip": "192.168.1.10",
"server_id": 5,
"status": "active"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Ошибка получения данных"
}

reports/pdu¶

Возвращает отчет по устройствам распределения питания (PDU) для указанной локации.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `pdu`
token	✅	string	Токен авторизации
location	❌	string	Локация (DC). По умолчанию 'all'.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=pdu" \
--data "token=HOSTKEY_TOKEN" \
--data "location=NL"

Пример успешного ответа

{
"result": "OK",
"module": null,
"action": "pdu",
"pdus": [
{
"id": 1,
"name": "PDU-Unit-01",
"status": "active",
"location": "NL"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Authentication required or invalid token"
}

reports/port_of_virt_node¶

Возвращает список портов для виртуальных узлов в указанной локации.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `port_of_virt_node`
token	✅	string	Токен авторизации
location	❌	string	Локация (DC). По умолчанию 'all'.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=port_of_virt_node" \
--data "token=HOSTKEY_TOKEN" \
--data "location=all"

Пример успешного ответа

{
"result": "OK",
"module": null,
"action": "port_of_virt_node",
"data": [
{
"id": 10,
"name": "VirtPort-01",
"status": "active"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Authentication required or invalid token"
}

reports/power_consumption¶

Возвращает отчет по энергопотреблению.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `power_consumption`
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=power_consumption" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"module": "reports",
"action": "power_consumption",
"data": [
{
"id": 5,
"value": 120.5,
"unit": "W"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Authentication required or invalid token"
}

reports/presets_calculate_roi¶

Запускает процесс расчета окупаемости (ROI) для пресетов.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `presets_calculate_roi`
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=presets_calculate_roi" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"Billable": {},
"Count": {},
"Free": {},
"ID": null,
"ROI": {},
"RUR": null,
"Revenue": {},
"eq_count": 0,
"eq_id": 0,
"for_sale_eq_count": 0,
"hardware_cost": 0,
"install_cost": 0,
"location": "string",
"power_cost": 0,
"power_cost_min": 0
}

Примеры ошибок

{
"code": -1,
"message": "Authentication required or invalid token"
}

reports/presets_get_roi¶

Возвращает данные о показателях ROI для пресетов.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `presets_get_roi`
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=presets_get_roi" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"data": [
{
"roi": {
"component_id": 123,
"ROI": 45.5,
"Revenue": 1000.0
},
"preset_data": {
"component_id": 123
}
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Authentication required or invalid token"
}

reports/presets_get_roi¶

Возвращает данные о рентабельности (ROI) для различных компонентов.

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `presets_get_roi`
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=presets_get_roi" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"data": [
{
"roi": {},
"preset_data": {}
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Authentication required or invalid token"
}

reports/registrations¶

Возвращает список регистраций (экспорт в CSV).

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `registrations`
token	✅	string	Токен авторизации
site	❌	string	Сайт для фильтрации. По умолчанию 'any'.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X GET \
--data "action=registrations" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "registrations",
"data": [
{
"id": 1,
"guest_hash_id": "string",
"email": "user@example.com",
"name": "string",
"surname": "string",
"companyName": "string",
"city": "string",
"address1": "string",
"sms": "string",
"secretword": "string",
"vat": "string",
"country": "string",
"region": "string",
"company": "string",
"address2": "string",
"payment": "string",
"currency": "string",
"clientip": "string",
"subscribe": true,
"is_registered": true,
"site": "string",
"created_at": "2024-01-01T12:00:00Z"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Authentication required or invalid token"
}

reports/show¶

Возвращает детализированную информацию по конкретному отчету.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: show
token	✅	string	Токен авторизации
id	❌	integer	ID отчета.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=show" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

Пример успешного ответа

{
"result": "OK",
"action": "show",
"report": {
"id": 123,
"name": "Report Name"
}
}

Примеры ошибок

{
"code": -1,
"message": "Report not found"
}

reports/sms_log¶

Возвращает список записей журнала отправки SMS-сообщений с пагинацией.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `sms_log`
token	✅	string	Токен авторизации
gateway	❌	string	Идентификатор шлюза SMS.
page	❌	integer	Номер страницы для пагинации. По умолчанию 1.
per_page	❌	integer	Количество записей на страницу. По умолчанию 100.
data	✅	string	Параметр `data`
total	✅	integer	Параметр `total`
gateways	✅	string	Параметр `gateways`

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=sms_log" \
--data "token=HOSTKEY_TOKEN" \
--data "gateway=VALUE" \
--data "page=1" \
--data "per_page=100" \
--data "data=VALUE" \
--data "total=VALUE" \
--data "gateways=VALUE"

Пример успешного ответа

{
"result": "OK",
"module": null,
"action": "sms_log",
"data": [
{
"id": 123,
"message": "Your verification code is 1234",
"status": "sent",
"timestamp": "2024-05-20T12:00:00Z"
}
],
"total": 50,
"page": 1,
"per_page": 100,
"gateways": [
{
"id": "gw_1",
"name": "Twilio"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Authentication required"
}

reports/suspension_journal¶

Возвращает список записей журнала приостановки услуг с применением фильтрации.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `suspension_journal`
filter	❌	array	Объект фильтрации для отчета. Принимает JSON-строку.
token	❌	string	Уникальный идентификатор сессии или токен авторизации пользователя.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=suspension_journal"

Пример успешного ответа

{
"result": "OK",
"module": null,
"action": "suspension_journal",
"data": [
{
"id": 123,
"status": "suspended",
"created_at": "2024-05-20T14:30:00Z",
"reason": "Non-payment"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Error generating report"
}

reports/timetable¶

Возвращает график работы (таймлайн) сотрудника.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: timetable
token	✅	string	Токен авторизации
tt_type	❌	string	Формат вывода. Допустимые значения: tt.
period_from	❌	string	Дата начала периода (ISO формат).
period_to	❌	string	Дата окончания периода (ISO формат).
employee	✅	string	Уникальный идентификатор или логин сотрудника для формирования отчета по рабочему времени.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=timetable" \
--data "token=HOSTKEY_TOKEN" \
--data "employee=VALUE"

Пример успешного ответа

{
"result": "OK",
"data": [
{
"date": "2024-05-20",
"dow": "Monday",
"start": "09:00:00",
"finish": "18:00:00",
"period": 9.0
}
],
"format": "tt"
}

Примеры ошибок

{
"code": -1,
"message": "$module/timetable: permission denied for timetable for $employee"
}

reports/tplatforms¶

Генерирует отчет использования T-платформ за указанный период.

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `tplatforms`
token	✅	string	Токен авторизации
period_from	❌	string	Дата начала периода.
period_to	❌	string	Дата окончания периода.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=tplatforms" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"module": null,
"action": "tplatforms",
"data": [
{
"platform": "AWS",
"usage": 150.5,
"date": "2024-05-01"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Invalid dates"
}

reports/traffic_invoices¶

Возвращает детализацию использования трафика, сгруппированную по валютам.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `traffic_invoices`
token	✅	string	Токен авторизации
filter	❌	`array<object>`	Фильтр для отчета (JSON объект). Если не указан, используется пустой массив.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=traffic_invoices" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"module": null,
"action": "traffic_invoices",
"data": [
{
"id": 1,
"currency": "EUR",
"amount": 50.0,
"user_name": "John Doe"
}
],
"totals": {
"EUR": 120.5,
"RUB": 12000.0,
"USD": 130.0
},
"total_eur": 120.5,
"rates": {
"EUR_RUB": 100.0,
"EUR_USD": 1.1,
"updated": "2024-05-20T10:00:00Z"
}
}

Примеры ошибок

{
"code": -1,
"message": "Invalid filter format"
}

reports/traffic_usage¶

Возвращает отчет об использовании трафика серверами с возможностью шейпинга (ограничения).

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `traffic_usage`
token	✅	string	Токен авторизации
report_type	❌	integer	Тип отчета.
location	❌	string	Локация (DC).
billing	❌	string	Биллинг.
notify	❌	integer	Отправить уведомления клиентам по email. Допустимые значения: 0, 1.
shape	❌	integer	Ограничить (шейпить) серверы с перерасходом. Допустимые значения: 0, 1.
debug	❌	string	Режим отладки для вывода подробной информации об ошибках.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=traffic_usage" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"module": "unknown",
"action": "traffic_usage",
"report_type": 1,
"data": [
{
"id": 505,
"client": "user@example.com",
"limit_in": 100,
"limit_out": 100
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Unknown error during shaping"
}

reports/update¶

Обновляет данные в отчете по указанному ID с использованием переданных параметров.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: update
token	✅	string	Токен авторизации
id	❌	integer	ID записи отчета (может быть передан через POST или GET)
params	✅	`array<string>`	Массив параметров для обновления данных отчета
params[key]	❌	string	Дополнительные параметры для обновления данных отчета

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=update" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "params[]=value1" \
--data "params[]=value2"

Пример успешного ответа

{
"result": "OK",
"module": "unknown",
"action": "update",
"report": {}
}

Примеры ошибок

{
"code": -1,
"message": "Ошибка при обновлении отчета"
}

reports/update_ltv¶

Запуск процесса обновления показателей LTV (Lifetime Value). Метод является устаревшим и вызывается по расписанию.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `update_ltv`
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=update_ltv" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "update_ltv"
}

Примеры ошибок

{
"code": -1,
"message": "Endpoint retired"
}

reports/update_racks_power¶

Обновляет теги энергопотребления для стоек (среднее, теоретическое и максимальное значения) на основе текущих данных.

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `update_racks_power`
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X GET \
--data "action=update_racks_power" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"module": "...",
"action": "update_racks_power",
"message": "X records added"
}

Примеры ошибок

{
"code": -1,
"message": "Ошибка при обновлении данных энергопотребления"
}

reports/user_control_locks¶

Возвращает список записей о блокировках/управлении пользователями.

HTTP-метод: GET

Параметры:

action	✅	string	Идентификатор метода: `user_control_locks`
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X GET \
--data "action=user_control_locks" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"module": null,
"action": "user_control_locks",
"data": []
}

Примеры ошибок

{
"code": -1,
"message": "Ошибка получения данных о блокировках"
}

reports/vat_report¶

Генерирует отчет по инвойсам с учетом налогов (VAT) для указанного региона и периода.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `vat_report`
token	✅	string	Токен авторизации
params[region]	❌	string	Регион для отчета. По умолчанию: CH.
params[date_from]	❌	string	Дата начала периода (формат Y-m-d H:i:s). По умолчанию: за последний месяц.
params[date_to]	❌	string	Дата окончания периода (формат Y-m-d H:i:s). По умолчанию: текущая дата.
params[location]	❌	string	Локация (биллинг) для фильтрации.
region	✅	string	Параметр `region`
period_from	✅	string	Параметр `period_from`
period_to	✅	string	Параметр `period_to`
billing	✅	string	Параметр `billing`
date_from	❌	string	Дата начала отчетного периода для формирования налогового отчета.
date_to	❌	string	Дата окончания отчетного периода для формирования налогового отчета.
location	❌	string	Местоположение или адрес биллинга для фильтрации данных в отчете.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=vat_report" \
--data "token=HOSTKEY_TOKEN" \
--data "region=VALUE" \
--data "period_from=VALUE" \
--data "period_to=VALUE" \
--data "billing=VALUE"

Пример успешного ответа

{
"result": "OK",
"module": "unknown",
"action": "vat_report",
"data": []
}

Примеры ошибок

{
"code": -1,
"message": "Ошибка генерации VAT отчета"
}

reports/whmcs_services¶

Получает список сервисов из системы WHMCS для сверки с локальными данными.

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `whmcs_services`
token	✅	string	Токен авторизации
as_csv	❌	integer	Флаг экспорта в CSV. Если значение больше 0, данные возвращаются в формате CSV.
delim	❌	string	Разделитель для CSV. По умолчанию: точка.
params[as_csv]	❌	integer	Флаг экспорта в CSV (1 - да, 0/другое - нет).
params[delim]	❌	string	Разделитель для CSV. По умолчанию: точка.
location	❌	string	Идентификатор или название локации для фильтрации сервисов.
period_from	❌	string	Дата начала отчетного периода.
period_to	❌	string	Дата окончания отчетного периода.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X GET \
--data "action=whmcs_services" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"module": "unknown",
"action": "whmcs_services",
"services": []
}

Примеры ошибок

{
"code": -1,
"message": "Ошибка получения данных из WHMCS"
}

reports/windows_ip¶

Возвращает список IP-адресов серверов с лицензионным ПО Windows для активации.

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `windows_ip`
token	✅	string	Токен авторизации
location	❌	string	Идентификатор или название локации для получения списка IP-адресов серверов.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X GET \
--data "action=windows_ip" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"module": "unknown",
"action": "windows_ip",
"data": []
}

Примеры ошибок

{
"code": -1,
"message": "Ошибка получения списка IP"
}

reports/yookassa_refund_journal¶

Возвращает список записей о возвратах через систему YooKassa за указанный период.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `yookassa_refund_journal`
token	✅	string	Токен авторизации
date_from	❌	string	Дата начала периода (формат Y-m-d H:i:s). По умолчанию null.
date_to	❌	string	Дата окончания периода (формат Y-m-d H:i:s). По умолчанию null.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=yookassa_refund_journal" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"module": "...",
"action": "yookassa_refund_journal",
"data": [
{
"id": 123,
"amount": 500.0,
"currency": "RUB",
"status": "completed",
"created_at": "2024-01-15T10:30:00Z"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Ошибка выполнения запроса"
}

reports/billing_cycle_journal_migrate¶

Запускает процесс миграции старых данных журналов биллинга.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `billing_cycle_journal_migrate`
token	✅	string	Токен авторизации пользователя

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=billing_cycle_journal_migrate" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "billing_cycle_journal_migrate",
"data": {
"status": "success",
"migrated_count": 20
}
}

Примеры ошибок

{
"code": -1,
"message": "Migration failed"
}

reports/get_data¶

Возвращает детальные данные объекта (отчет) по его ID.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_data`
id	❌	integer	ID объекта.
params	❌	object	Дополнительные параметры запроса.
token	❌	string	Уникальный идентификатор сессии или ключ доступа для авторизации запроса.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=get_data" \
--data "id=123" \
--data "token=your_token_here"

Пример успешного ответа

{
"result": "OK",
"module": "unknown",
"action": "get_data",
"id": 123,
"data": {}
}

Примеры ошибок

[]

reports/idle¶

Возвращает список серверов, которые находятся в режиме ожидания (не в fleet).

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `idle`
token	✅	string	Токен авторизации пользователя

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=idle" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"data": [
{
"id": 10,
"name": "Server-Idle-01",
"status": "active",
"rhr": {
"assignee": "anyone",
"request": "unknown"
}
}
]
}

Примеры ошибок

[]

reports/openstack_nodes¶

Возвращает список узлов и сводную информацию по платформе OpenStack.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `openstack_nodes`
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=openstack_nodes" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"module": null,
"action": "openstack_nodes",
"nodes": [
{
"id": 1,
"name": "os-node-01",
"status": "active"
}
],
"summary": {
"total": 5,
"active": 4
}
}

Примеры ошибок

{
"code": -1,
"message": "Ошибка получения данных узлов"
}

reports/ovirt_nodes¶

Возвращает список узлов и сводную информацию по платформе OVIRT.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `ovirt_nodes`
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=ovirt_nodes" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"module": null,
"action": "ovirt_nodes",
"nodes": [
{
"id": 10,
"name": "ovirt-host-01",
"status": "up"
}
],
"summary": {
"total": 2,
"active": 2
}
}

Примеры ошибок

{
"code": -1,
"message": "Ошибка получения данных узлов"
}

reports/try¶

Выполняет пробный (test) запуск метода report_try с переданными параметрами.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: try
token	✅	string	Токен авторизации
params	❌	object	Контейнер с бизнес-параметрами для метода report_try.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=try" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"module": "unknown",
"action": "try",
"report": {}
}

Примеры ошибок

{
"code": -1,
"message": "Error in report execution"
}