options.php¶

Модуль управления опциями: привязка лицензий к серверам, получение истории изменений и просмотр логов программного обеспечения

Методы API¶

Метод	Действие	Описание
`bind`	привязка опции	Привязывает выбранную опцию (например, лицензию) к серверу или IP-адресу.
`history`	получение истории	Возвращает историю изменений для указанной сущности.
`logs`	получение логов	Возвращает логи для программного обеспечения (software). Доступно только для опции software.

options/bind¶

Привязывает выбранную опцию (например, лицензию) к серверу или IP-адресу.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `bind`
token	✅	string	Токен авторизации
option	✅	string	Название опции. Допустимые значения: component1, eq, hardware, ip, ipaddress, ipadress2, ipmip, ipv4r, ipv4rs, lic, license, loc, location, locations, ma, net, netinterface, netinterface1, part, pdns-domain, pdns-subdomain, preorders, rack, rack1, rep, reporttemplate, rh_requests, rhr, rhrequests, sshkey, sshkeys, sup, tags_mgr, tm, vlan, vlans, waybills, waybills_hardware, wb, wbd
id	❌	integer	ID сервера или IP-адрес
option_id	❌	integer	ID опции для привязки
option_count	❌	integer	Количество опций. По умолчанию 1.
ip	❌	string	IP-адрес сервера
bind	✅	string	Тип привязки: ip или server
server_id	❌	integer	ID сервера (из данных оборудования)
eq	❌	integer	ID оборудования для привязки
bm	❌	integer	Флаг типа таблицы Server (1)
vm	❌	integer	Флаг типа таблицы VPS (1)

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

curl -s "https://invapi.hostkey.ru/options.php" -X POST \
--data "action=bind" \
--data "token=YOUR_TOKEN" \
--data "option=lic" \
--data "bind=server" \
--data "server_id=123"

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

{
"list": {},
"license_result": {},
"debug": null
}

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

{
"code": -1,
"message": "failed to list option license: error message while ..."
}

options/history¶

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

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `history`
token	✅	string	Токен авторизации
option	✅	string	Компонент для получения истории: api_keys, cl, component1, cust, customers, dash, dash-rep, dashboard, dashboards, datacenter, dc, distributors, empl, employee1, employees, eq, hardware, ip, ipaddress, ipadress2, ipmip, ipv4r, ipv4rs, iso, iso-image, iso-images, iso_list, lic, license, loc, location, locations, ma, net, netinterface, netinterface1, part, pdns-domain, pdns-subdomain, preorders, rack, rack1, rep, reporttemplate, rh_requests, rhr, rhrequests, sshkey, sshkeys, sup, tags_mgr, tm, vlan, vlans, waybills, waybills_hardware, wb, wbd
id	❌	integer	ID объекта (сущности) в истории

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

curl -s "https://invapi.hostkey.ru/options.php" -X POST \
--data "action=history" \
--data "token=HOSTKEY_TOKEN" \
--data "option=hardware" \
--data "id=123"

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

{
"result": "OK",
"action": "history",
"data": [
{
"id": 123,
"message": "Software updated: field = value",
"created_at": "2024-01-15T10:30:00Z"
}
]
}

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

{
"code": -1,
"message": "failed to get history"
}

options/logs¶

Возвращает логи для программного обеспечения (software). Доступно только для опции software.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/options.php" -X POST \
--data "action=logs" \
--data "token=YOUR_TOKEN" \
--data "option=software" \
--data "id=123"

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

{
"logs": [
{
"id": 1,
"event": "install",
"details": "{}",
"created_at": "2024-05-20T12:00:00Z"
}
]
}

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

{
"code": 400,
"message": "logs action is only supported for software option"
}