journal.php¶

В этой статье

Методы API

journal/delete

journal/list

API для управления операционным журналом: удаление записей и получение детализированных списков событий с фильтрацией по различным параметрам.

Методы API¶

Метод	Действие	Описание
`delete`	удаление записи журнала	Удаляет запись из операционного журнала по идентификатору.
`list`	получение списка записей журнала	Возвращает список событий операционного журнала с поддержкой расширенной фильтрации и пагинации.

journal/delete¶

Удаляет запись из операционного журнала по идентификатору.

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `delete`
token	✅	string	Токен авторизации
id	❌	integer	Идентификатор записи журнала для удаления.

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

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

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

{
"result": "OK"
}

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

{
"code": 0,
"message": "$module: missing token"
}

journal/list¶

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

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `list`
token	✅	string	Токен авторизации
id	❌	integer	ID записи (если > 0)
server_id	❌	integer	Идентификатор сервера.
actions	❌	string	Фильтр по типам действий. Допустимые значения: suspends (suspend/unsuspend), links (link/unlink), all (link, unlink, suspend, unsuspend).
billing	❌	string	Фильтр по биллинговому периоду или параметру.
user	❌	string	Имя пользователя для фильтрации.
preset	❌	string	Идентификатор пресета.
location	❌	string	Локация сервера.
period_from	❌	string	Дата начала периода (date_from).
period_to	❌	string	Дата окончания периода (date_to).
psummary	❌	string	Параметр для получения сводной информации.
new_customer	❌	integer	Фильтр по новым клиентам (1 - только новые).
sla	❌	string	Параметр SLA.
monthly_cost	❌	string	Фильтр по ежемесячной стоимости.
monthly_sort	❌	string	Сортировка по стоимости. Допустимые значения: asc, desc.
page	❌	integer	Номер страницы (по умолчанию 1).
page_size	❌	integer	Количество записей на страницу (по умолчанию 50).
include_utm	❌	string	Включить UTM-метки в отчет. Допустимые значения: "0", "1".
include_total	❌	string	Включить итоговые суммы в ответ. Допустимые значения: "0", "1".
service_type	❌	string	Тип услуги. Допустимые значения: "", "VPS", "GPU", "vGPU", "Dedicated", "Other".
snapshot_id	❌	integer	Идентификатор снапшота.

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

curl -s "https://invapi.hostkey.ru/journal.php" -X POST \
--data "action=list" \
--data "token=HOSTKEY_TOKEN" \
--data "server_id=12345" \
--data "actions=all"

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

{
"result": "OK",
"data": [
{
"id": 1001,
"event": "Server Rebooted",
"user": "admin"
}
],
"total_rows": 1,
"totals": {},
"total_pcs": 1,
"total_services": 1,
"snapshot_id": 123,
"total_eur": 45.99,
"unknown_prices": [],
"page": 1,
"page_size": 50
}

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

{
"code": -1,
"message": "journal/list: invalid include_utm value"
}