eq.php¶

API модуль управления оборудованием: управление бэкапами, настройка IPMI пользователей и анонсирование IP-адресов.

Методы API¶

Метод	Действие	Описание
`abort_reinstall`	прерывание переустановки	Отменяет процесс переустановки ОС, удаляет временные теги и восстанавливает настройки VLAN.
`add_ipmi_user`	добавление IPMI пользователя	Создает нового пользователя для доступа к IPMI интерфейсу сервера.
`announceip`	анонсирование IP	Настройка анонса IP-адресов (BGP/Announce).
`backup_get_schedule`	получение расписания бэкапов	Возвращает текущее расписание резервного копирования для сервера.
`backup_list`	получение списка бэкапов	Возвращает список доступных резервных копий сервера.
`backup_save_schedule`	сохранение расписания бэкапов	Сохраняет новое расписание резервного копирования.
`boot_dev`	загрузка с носителя	Запрашивает загрузку сервера с указанного носителя (PXE или диск).
`check_backup_lock`	проверка блокировки бэкапа	Проверяет наличие активной блокировки на выполнение операций с бэкапом для указанного сервера.
`check_pin`	проверка PIN-кода	Проверяет валидность PIN-кода для выполнения операций с оборудованием.
`clear_pxe`	очистка PXE	Очищает PXE-конфигурацию для конкретного хоста.
`console`	запрос консоли	Запрашивает доступ к консоли сервера (NoVNC/IPMI).
`create_backup`	создание бэкапа	Запускает процесс создания резервной копии для указанного сервера.
`create_pxe`	создание PXE конфигурации	Создает конфигурацию для загрузки сервера через PXE (для переустановки ОС).
`delete_backup`	удаление бэкапа	Запускает процесс удаления указанного бэкапа.
`deploy`	запуск развертывания сервера	Инициирует процесс деплоя (развертывания) конкретного сервера или пресета. Поддерживает как стоковые серверы, такs и развертывание по шаблону.
`get_ipmi`	получение IPMI данных	Возвращает IP-адрес и модель интерфейса IPMI для сервера.
`get_traffic`	получение трафика	Возвращает данные по использованию IPv4 трафика для сервера.
`get_upgrade_key`	получение ключа апгрейда	Возвращает ключ для выполнения операции апгрейда, привязанный к инвойсу.
`getserversforannounce`	получение серверов для анонса	Возвращает список доступных серверов, подходящих под условия анонса IP-подсети.
`groups`	получение групп	Возвращает список групп, привязанных к конкретному серверу.
`hard_off`	принудительное выключение	Отправляет команду на немедленное (жесткое) выключение сервера через IPMI.
`list`	получение списка оборудования	Возвращает список доступного или арендованного оборудования с фильтрацией по различным параметрам (статус, локация, тип и т.д.)
`novnc`	запрос консоли NoVNC	Запрашивает доступ к консоли управления через NoVNC для указанного сервера.
`off`	выключение сервера	Запрос на выключение (Stop) указанного сервера.
`on`	включение сервера	Запрос на включение (Start) указанного сервера.
`order_instance`	заказ инстанса/переустановка	Запуск процесса развертывания нового сервера по пресету или переустановки существующего.
`ovirt_novnc`	запрос oVirt NoVNC консоли	Запрашивает доступ к консоли управления через oVirt NoVNC.
`reboot`	перезагрузка сервера	Запрос на перезагрузку (Reboot) указанного сервера.
`recreate_novnc`	пересоздание NoVNC консоли	Перезапускает сессию NoVNC для управления сервером через браузер.
`reinstall`	переустановка	Запускает процесс переустановки сервера и создает ключ для операции.
`remove_ipmi_user`	удаление IPMI пользователя	Удаляет дополнительные учетные записи пользователей IPMI.
`request_backup_link`	запрос ссылки на бэкап	Запрашивает временную ссылку для скачивания резервной копии.
`restore_backup`	восстановление из бэкапа	Запускает процесс восстановления сервера из выбранной резервной копии.
`search`	поиск оборудования	Поиск доступного оборудования по различным критериям (локация, тип, статус и др.).
`sensors`	получение данных сенсоров	Возвращает данные датчиков (температура, обороты и т.д.) для сервера.
`set_pin`	установка PIN-кода	Устанавливает новый PIN-код для доступа к управлению сервером.
`show`	получение данных о сервере	Возвращает детальную информацию о сервере, включая аппаратную конфигурацию и статус.
`status`	проверка статуса	Возвращает текущий статус сервера и ключ для callback.
`status_check`	проверка системного статуса	Возвращает общую информацию о состоянии системы.
`stop_novnc`	остановка консоли NoVNC	Завершает текущую сессию NoVNC для сервера.
`suspend`	приостановка (suspend)	Приостанавливает работу сервера (для VPS).
`suspend`	блокировка сервера	Запрашивает блокировку (suspension) VPS/сервера.
`traffic_add`	добавление трафика	Запрашивает увеличение лимита исходящего трафика и создает инвойс.
`unit_reset`	сброс IPMI модуля	Запрашивает сброс устройства (IPMI reset) для указанного сервера.
`unsuspend`	разблокировка сервера	Запрашивает разблокировку (unsuspension) VPS/сервера.
`update_servers`	обновление серверов	Обновляет список активных серверов для текущего токена/аккаунта.

eq/abort_reinstall¶

Отменяет процесс переустановки ОС, удаляет временные теги и восстанавливает настройки VLAN.

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"action": "abort_reinstall",
"id": 123
}

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

{
"code": -1,
"message": "$module/$action: invalid server id"
}

eq/add_ipmi_user¶

Создает нового пользователя для доступа к IPMI интерфейсу сервера.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `add_ipmi_user`
token	✅	string	Токен авторизации
id	✅	integer	ID сервера
admin_user	❌	string	Имя администратора IPMI (только для администраторов).
admin_pass	❌	string	Пароль администратора IPMI (только для администраторов).
require_proxy_credentials	❌	boolean	Флаг необходимости использования учетных данных прокси-сервера при настройке IPMI.

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=add_ipmi_user" \
--data "token=HOSTKEY_TOKEN" \
--data "id=12345"

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

{
"result": "OK",
"action": "add_ipmi_user",
"callback": "key_value"
}

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

{
"code": -1,
"message": "$module/$action: invalid server id"
}

eq/announceip¶

Настройка анонса IP-адресов (BGP/Announce).

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `announceip`
token	✅	string	Токен авторизации
id	✅	integer	ID сервера
subnet	❌	string	Подсеть для анонса. Допустимое значение: ipv4
server	❌	boolean	Флаг использования сервера.
subnetaddr	✅	string	Адрес в подсети. Должен заканчиваться на .0 и быть валидным IP.
subnetaddrmask	✅	string	Маска адреса в подсети. Допустимые значения: /23, /24.
asn	❌	string	Номер автономной системы. Допустимые значения: AS50867, AS395839, AS57043.
ownasn	❌	boolean	Использовать собственный ASN.
annonce	❌	string	Флаг анонса. Допустимые значения: hk, bgp.
return	❌	boolean	Возврат результата (для режима bgp).
route	❌	string	Флаг маршрутизации.
cmnt	❌	string	Комментарий к анонсу.
checkboxes	✅	boolean	Подтверждение условий (ASRegistered, RKPIValid, SubNetNotSpamhaus, DataIsCorrect).
loa	✅	file	LOA файл в формате .pdf размером до 1 МБ.
ASRegistered	✅	string	Параметр ASRegistered (должен быть равен 1)
RKPIValid	✅	string	Параметр RKPIValid (должен быть равен 1)
SubNetNotSpamhaus	✅	string	Параметр SubNetNotSpamhaus (должен быть равен 1)
DataIsCorrect	✅	string	Параметр DataIsCorrect (должен быть равен 1)
whmcs_id	❌	integer	ID из WHMCS
whmcs_location	❌	string	Локация из WHMCS
email	❌	string	Email пользователя
subaccount	❌	string	ID субсчетчика

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=announceip" \
--data "token=VALUE" \
--data "id=VALUE" \
--data "subnetaddr=1.2.3.0" \
--data "subnetaddrmask=/24" \
--data "checkboxes=true" \
--data "loa=@path/to/file.pdf" \
--data "ASRegistered=1" \
--data "RKPIValid=1" \
--data "SubNetNotSpamhaus=1" \
--data "DataIsCorrect=1"

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

{
"result": 0,
"IP": "1.2.3.4",
"IsMain": true,
"Status": "active"
}

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

{
"code": -1,
"message": "Error details from eq_announce_ip"
}

eq/backup_get_schedule¶

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

HTTP-метод: GET

Параметры:

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

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

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

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

{
"result": "OK",
"module": "unknown",
"action": "backup_get_schedule",
"schedule": [
{
"days": [0, 1, 2, 3, 4, 5, 6],
"time": "string",
"timezone": "string"
}
]
}

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

[]

eq/backup_list¶

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

HTTP-метод: GET

Параметры:

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

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

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

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

{
"result": "OK",
"module": "eq",
"action": "backup_list",
"data": [
{
"id": 1,
"name": "daily_backup",
"date": "2024-05-20 03:00:00"
}
]
}

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

[]

eq/backup_save_schedule¶

Сохраняет новое расписание резервного копирования.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `backup_save_schedule`
token	✅	string	Токен авторизации
id	✅	integer	ID сервера
backup_schedule	❌	`array<string>`	Массив с настройками расписания. Содержит ключи days, time и timezone.

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=backup_save_schedule" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "backup_schedule[days][0]=monday" \
--data "backup_schedule[time]=03:00" \
--data "backup_schedule[timezone]=UTC"

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

{
"result": "OK",
"module": "eq",
"action": "backup_save_schedule"
}

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

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

eq/boot_dev¶

Запрашивает загрузку сервера с указанного носителя (PXE или диск).

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `boot_dev`
token	✅	string	Токен авторизации
id	✅	integer	ID сервера
media	✅	string	Тип загрузочного носителя.
boot_mode	❌	string	Режим загрузки. Допустимые значения: auto, uefi, legacy.

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=boot_dev" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE" \
--data "media=VALUE" \
--data "boot_mode=uefi"

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

{
"result": "OK",
"action": "boot_dev",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

{
"code": -1,
"message": "Bootable media change request failed: error_message"
}

eq/check_backup_lock¶

Проверяет наличие активной блокировки на выполнение операций с бэкапом для указанного сервера.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=check_backup_lock" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"

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

{
"result": "OK",
"module": "eq",
"action": "check_backup_lock",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

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

eq/create_backup¶

Запускает процесс создания резервной копии для указанного сервера.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=create_backup" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"

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

{
"result": "OK",
"module": "eq",
"action": "create_backup",
"callback": "7bc29eb23fb1b879b21fce509597f07c",
"traceKey": "uuid-string"
}

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

{
"code": -1,
"message": "Ошибка создания бэкапа"
}

eq/delete_backup¶

Запускает процесс удаления указанного бэкапа.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `delete_backup`
token	✅	string	Токен авторизации
id	✅	integer	ID сервера
params[name]	✅	string	Имя бэкапа для удаления
name	❌	string	Имя резервной копии для удаления.

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=delete_backup" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE" \
--data "params[name]=VALUE"

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

{
"result": "OK",
"module": "eq",
"action": "delete_backup",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

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

eq/create_pxe¶

Создает конфигурацию для загрузки сервера через PXE (для переустановки ОС).

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `create_pxe`
token	✅	string	Токен авторизации
id	✅	integer	ID сервера
params[os_id]	✅	integer	ID операционной системы
params[hostname]	✅	string	Имя хоста (hostname)
params[root_pass]	✅	string	Пароль root
params[ssh_key]	❌	string	SSH ключ
params[disk_mirror]	❌	string	Схема зеркалирования дисков. Допустимые значения: -1, DM_RAID0, DM_RAID1, DM_RAID10, HW_RAID0, HW_RAID1, HW_RAID5, HW_RAID6, LVM_HBA, LVM_RAID0, LVM_RAID1, LVM_RAID10, LVM_RAID10S, null.
params[uefi]	❌	integer	Режим загрузки UEFI (0 или 1)
ignore_duplicated_install	✅	string	Параметр ignore_duplicated_install. Доступен только для администраторов.
deploy_ticket	✅	string	Параметр deploy_ticket. Доступен только для администраторов.
manual_choice_dsk	✅	string	Если значение больше 0, устанавливается режим ручного выбора диска.
root_pass	✅	string	Пароль суперпользователя root для новой операционной системы.
os_id	❌	integer	Идентификатор выбранного образа операционной системы.
ssh_key	❌	string	Публичный SSH-ключ для автоматического добавления в систему.
post_install_script	❌	string	Скрипт для выполнения на сервере после завершения установки ОС.
post_install_callback	❌	string	URL-адрес для вызова обратного вызова по завершении процесса установки.
hostname	✅	string	Имя хоста сервера в сети.
reinstall_key	❌	string	Ключ для переустановки системы или активации лицензии.
email	❌	string	Адрес электронной почты пользователя.
os_name	❌	string	Алиас или название операционной системы для поиска образа.
disk_mirror	❌	string	Конфигурация зеркалирования дисков. Допустимые значения: -1, DM_RAID0, DM_RAID1, DM_RAID10, HW_RAID0, HW_RAID1, HW_RAID5, HW_RAID6, LVM_HBA, LVM_RAID0, LVM_RAID1, LVM_RAID10, LVM_RAID10S, null.
uefi	❌	integer	Режим загрузки системы: UEFI или Legacy (через -1).
attendedInstall	❌	string	Параметр для запуска автоматической установки операционной системы.
key	❌	string	Ключ конфигурации или идентификатор операции.
no_lvm	❌	string	Флаг для отключения использования LVM при разметке диска.
custom_domain	❌	string	Пользовательский домен для настройки сетевых параметров сервера.

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=create_pxe" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "params[os_id]=5" \
--data "params[hostname]=web-server" \
--data "params[root_pass]=SecretPass123!" \
--data "ignore_duplicated_install=0" \
--data "deploy_ticket=TICKET-123" \
--data "manual_choice_dsk=0" \
--data "root_pass=SecretPass123!" \
--data "hostname=web-server"

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

{
"result": "OK",
"action": "create_pxe",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

{
"code": -1,
"message": "Ошибка создания PXE конфигурации"
}

eq/console¶

Запрашивает доступ к консоли сервера (NoVNC/IPMI).

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=console" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"

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

{
"result": "OK",
"action": "console",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

{
"code": -1,
"message": "EQ/console: invalid server id"
}

eq/deploy¶

Инициирует процесс деплоя (развертывания) конкретного сервера или пресета. Поддерживает как стоковые серверы, такs и развертывание по шаблону.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `deploy`
token	✅	string	Токен авторизации
id	❌	integer	ID сервера для деплоя (если не указан пресет)
preset	❌	string	Название пресета для развертывания
location	❌	integer	ID локации (датацентра)
hostname	❌	string	Имя хоста для сервера
os_id	❌	integer	ID операционной системы
root_pass	❌	string	Пароль root. Не должен быть короче 8 символов.
ssh_key	❌	string	SSH публичный ключ
post_install_script	❌	string	Скрипт после установки (должен начинаться с #!/path/to/interpreter)
post_install_callback	❌	string	URL для callback после установки
cloud_init_script	❌	string	Cloud-init скрипт (должен начинаться с #cloud-config)
ipv4_amount	❌	integer	Количество IPv4 адресов. Допустимые значения: 1, 2, 4, 6, 8.
disk_mirror	❌	string	Схема зеркалирования дисков. Допустимые значения: -1, DM_RAID0, DM_RAID1, DM_RAID10, HW_RAID0, HW_RAID1, HW_RAID5, HW_RAID6, LVM_HBA, LVM_RAID0, LVM_RAID1, LVM_RAID10, LVM_RAID10S, null.
custom_domain	❌	string	Пользовательский домен
service_id	❌	integer	ID сервиса для привязки (prebill)
deploy_ticket	❌	string	ID существующего тикета Kayako
imitate_error	❌	boolean	Имитация ошибки при деплое
imitate_deploy	❌	integer	Режим имитации (dry run)
own_os	❌	integer	Использование собственной ОС
activate_windows	❌	boolean	Активация Windows
attendedInstall	❌	boolean	Установка с участием пользователя (attended)
jenkins_task	❌	integer	ID задачи Jenkins
jenkins_tests	❌	boolean	Запуск тестов Jenkins
traffic_plan	❌	integer	План трафика (-1 для отсутствия)
manual_choice_dsk	❌	boolean	Ручной выбор диска
root_size	❌	integer	Размер корневого раздела (20-100)
reinstall_key	❌	string	Ключ для переустановки операционной системы.
deploy_period	❌	string	Период действия услуги после развертывания.
deploy_price	❌	string	Стоимость услуги при развертывании.
deploy_notify	❌	string	Настройки уведомлений при выполнении операции.
deploy_comment	❌	string	Комментарий к процессу развертывания сервера.
os_name	❌	string	Название устанавливаемой операционной системы.
invoice_relid	❌	integer	Связанный идентификатор счета для резервирования сервера.
uefi	❌	integer	Режим загрузки системы: UEFI или Legacy.
no_lvm	❌	string	Параметр для отключения использования LVM при установке.

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=deploy" \
--data "token=YOUR_TOKEN" \
--data "preset=standard-ubuntu" \
--data "root_pass=SecurePassword123!"

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

{
"result": "OK",
"action": "deploy",
"callback": "7bc29eb23fb1b879b21fce509597f07c",
"ticket": 12345,
"id": 123
}

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

{
"code": -1,
"message": "EQ/deploy: invalid server id"
}

eq/get_ipmi¶

Возвращает IP-адрес и модель интерфейса IPMI для сервера.

HTTP-метод: GET

Параметры:

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

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

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

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

{
"result": "OK",
"ipmi": [
{
"IP": "192.168.1.100",
"MAC": "00:1A:4B:3C:5D:6E",
"vendor": "Dell iDRAC"
}
]
}

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

{
"code": -1,
"message": "No IPMI interfaces found"
}

eq/get_traffic¶

Возвращает данные по использованию IPv4 трафика для сервера.

HTTP-метод: GET

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X GET \
--data "action=get_traffic" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

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

{
"result": "OK",
"module": "eq",
"action": "get_traffic",
"traffic": [
{
"direction": "outbound",
"ip": "1.2.3.4",
"updated": "2024-05-20 12:00:00",
"volume": 542.5,
"billed": false
}
],
"id": 123
}

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

{
"code": -1,
"message": "eq/get_traffic: invalid server id"
}

eq/get_upgrade_key¶

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

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=get_upgrade_key" \
--data "token=HOSTKEY_TOKEN" \
--data "id=12345" \
--data "invoice_id=67890"

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

{
"result": "OK",
"module": "eq",
"action": "get_upgrade_key",
"key": ""
}

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

{
"code": -1,
"message": "Permission denied"
}

eq/getserversforannounce¶

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

HTTP-метод: GET

Параметры:

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

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

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

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

{
"result": "OK",
"module": "eq",
"action": "getserversforannounce",
"servers": [
{
"id": 10,
"location": "NL",
"mask_23": "255.255.254.0",
"mask_24": "255.255.255.0",
"remaining_units": 5
}
]
}

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

{
"code": -1,
"message": "This subaccount is not allowed to announce IP."
}

eq/groups¶

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

HTTP-метод: GET

Параметры:

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

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

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

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

{
"result": "OK",
"groups": []
}

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

{
"code": -1,
"message": "EQ/groups: invalid server id"
}

eq/hard_off¶

Отправляет команду на немедленное (жесткое) выключение сервера через IPMI.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=hard_off" \
--data "token=HOSTKEY_TOKEN" \
--data "id=12345" \
--data "key=unique_request_id"

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

{
"result": "OK",
"action": "hard_off",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

{
"code": -1,
"message": "Stop request failed"
}

eq/list¶

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

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `list`
token	✅	string	Токен авторизации
id	❌	`array<integer>`	ID оборудования для фильтрации. Принимает несколько значений: id[]=val1&id[]=val2
group	❌	`array<string>`	Группировка оборудования. Принимает несколько значений: group[]=val1&group[]=val2
dc	❌	`array<string>`	ID дата-центра. Принимает несколько значений: dc[]=val1&dc[]=val2
location	❌	`array<string>`	Код локации. Принимает несколько значений: location[]=RU&location[]=NL
rack	❌	`array<string>`	ID стойки. Принимает несколько значений: rack[]=val1&rack[]=val2
status	❌	`array<string>`	Статус оборудования. Принимает несколько значений: status[]=rent&status[]=power_off
owner	❌	`array<string>`	Владелец. Принимает несколько значений: owner[]=val1&owner[]=val2
component	❌	`array<string>`	ID компонента оборудования. Принимает несколько значений: component[]=val1&component[]=val2
type	❌	`array<string>`	Тип оборудования (server, switch и т.д.). Принимает несколько значений: type[]=val1&type[]=val2
ip	❌	`array<string>`	IP-адрес. Принимает несколько значений: ip[]=val1&ip[]=val2
mac	❌	`array<string>`	MAC-адрес. Принимает несколько значений: mac[]=val1&mac[]=val2
account_id	❌	`array<integer>`	ID аккаунта биллинга. Принимает несколько значений: account_id[]=val1&account_id[]=val2
billing	❌	`array<string>`	Регион биллинга (en/ru). Принимает несколько значений: billing[]=en&billing[]=ru
email	❌	`array<string>`	Email пользователя. Принимает несколько значений: email[]=val1&email[]=val2
name_client	❌	`array<string>`	Имя клиента. Принимает несколько значений: name_client[]=val1&name_client[]=val2
full	❌	`array<boolean>`	Возвращать полные данные. Принимает несколько значений: full[]=true&full[]=false
kvm	❌	`array<boolean>`	Фильтр по KVM. Принимает несколько значений: kvm[]=true&kvm[]=false
serialNumber	❌	`array<string>`	Серийный номер. Принимает несколько значений: serialNumber[]=val1&serialNumber[]=val2

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

curl -s "https://invapi.hostkey.ru/eq.php" -X GET \
--data "action=list" \
--data "token=YOUR_TOKEN" \
--data "status[]=rent" \
--data "status[]=power_off" \
--data "location[]=RU" \
--data "id[]=101"

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

{
"servers": [
{
"id": 101,
"name_server": "srv-01.example.com",
"owner": "user@example.com",
"status": "rent",
"billing": "en",
"ip": [
{
"IP": "192.168.1.1",
"Status": "active"
}
],
"project_ids": [],
"mounted_iso": "",
"ipmi_model": "none",
"is_prebill": false,
"is_owner": ""
}
]
}

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

{
"code": -1,
"message": "EQ/list: invalid server id"
}

eq/novnc¶

Запрашивает доступ к консоли управления через NoVNC для указанного сервера.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=novnc" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"

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

{
"result": "OK",
"action": "novnc",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

{
"code": -1,
"message": "NoVNC console request failed"
}

eq/off¶

Запрос на выключение (Stop) указанного сервера.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=off" \
--data "token=YOUR_TOKEN" \
--data "id=12345"

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

{
"result": "OK",
"action": "off",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

{
"code": -1,
"message": "Stop request failed"
}

eq/on¶

Запрос на включение (Start) указанного сервера.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=on" \
--data "token=HOSTKEY_TOKEN" \
--data "id=12345"

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

{
"result": "OK",
"action": "on",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

{
"code": -1,
"message": "Start request failed: error_details"
}

eq/order_instance¶

Запуск процесса развертывания нового сервера по пресету или переустановки существующего.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `order_instance`
token	✅	string	Токен авторизации
id	❌	integer	ID сервера (для переустановки)
preset	❌	string	Имя пресета для заказа нового инстанса
root_pass	✅	string	Пароль root. Не должен содержать символы @ или #.
os_id	❌	integer	ID операционной системы
ssh_key	❌	string	SSH публичный ключ
hostname	❌	string	Имя хоста (по умолчанию ID сервера)
root_size	✅	integer	Размер корневого раздела в ГБ. Допустимые значения: от 20 до 100.
ipv4_amount	❌	integer	Количество IPv4 адресов. Допустимые значения: 1, 2, 4, 6, 8.
disk_mirror	✅	string	Схема зеркалирования дисков. Допустимые значения: -1, DM_RAID0, DM_RAID1, DM_RAID10, HW_RAID0, HW_RAID1, HW_RAID5, HW_RAID6, LVM_HBA, LVM_RAID0, LVM_RAID1, LVM_RAID10, LVM_RAID10S, null.
vlan	❌	integer	ID приватного VLAN (для клиентов)
custom_domain	❌	string	Пользовательский домен
os_template	✅	string	Параметр os_template
soft_id	✅	integer	ID дополнительного программного обеспечения
service_id	✅	integer	ID услуги для биллинга (prebill)
post_install_script	❌	string	Скрипт после установки. Должен начинаться с директивы #! с указанием пути к интерпретатору.
cloud_init_script	❌	string	Скрипт cloud-init. Должен начинаться с #cloud-config.
ip	❌	string	Приватный IP адрес
traffic_plan	❌	integer	ID тарифного плана трафика
post_install_callback	❌	string	URL или путь для вызова после завершения установки.
reinstall_key	❌	string	Ключ для выполнения процедуры переустановки системы.
deploy_data	❌	string	Данные биллинга и параметры развертывания (только для администраторов).
deploy_options	❌	string	Дополнительные опции настройки при развертывании (только для администраторов).
deploy_period	❌	string	Период оплаты услуги, например, hourly или ежемесячно.
deploy_notify	❌	boolean	Флаг включения уведомлений при развертывании.
deploy_ticket	❌	string	ID тикета в системе поддержки для связи с процессом.
deploy_comment	❌	string	Комментарий к процессу развертывания системы.
imitate_deploy	❌	boolean	Режим имитации процесса развертывания для тестирования.
imitate_error	❌	boolean	Режим имитации ошибки при развертывании.
os_name	❌	string	Название или псевдоним операционной системы для установки.
own_os	❌	boolean	Флаг использования собственной операционной системы пользователя.
jenkins_tests	❌	string	Параметры для запуска тестов в Jenkins.
location_name	❌	string	Название локации (дата-центра), где будет размещен сервер.
invoice_relid	❌	integer	Связанный идентификатор позиции в инвойсе (только для администраторов).
uefi	❌	boolean	Флаг включения режима загрузки UEFI.
promocode	❌	string	Промокод для применения скидки к заказу.
no_lvm	❌	boolean	Флаг отключения использования LVM в конфигурации дисков.
currency_code	❌	string	Код валюты для расчета стоимости услуги.
ipv6block	❌	string	Параметры или блок IPv6 адресов.
invoice_id	❌	integer	Идентификатор инвойса для оплаты (только для администраторов).

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=order_instance" \
--data "token=HOSTKEY_TOKEN" \
--data "root_pass=VALUE" \
--data "root_size=VALUE" \
--data "disk_mirror=VALUE" \
--data "os_template=VALUE" \
--data "soft_id=VALUE" \
--data "service_id=VALUE"

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

{
"result": "OK",
"action": "order_instance",
"callback": "7bc29eb23fb1b879b21fce509597f07c",
"deploy_status": "install",
"id": 123,
"os_name": "Ubuntu 22.04",
"soft_name": "Nginx"
}

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

{
"code": -1,
"message": "EQ/order_instance: invalid disk_mirror 5"
}

eq/ovirt_novnc¶

Запрашивает доступ к консоли управления через oVirt NoVNC.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `ovirt_novnc`
token	✅	string	Токен авторизации
id	✅	integer	ID сервера
white_ip	❌	string	IP-адрес, разрешенный для подключения к консоли oVirt noVNC.

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=ovirt_novnc" \
--data "token=YOUR_TOKEN" \
--data "id=123"

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

{
"result": "OK",
"action": "ovirt_novnc",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

{
"code": -1,
"message": "oVirt noVNC console request failed"
}

eq/reboot¶

Запрос на перезагрузку (Reboot) указанного сервера.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=reboot" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"

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

{
"result": "OK",
"action": "reboot",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

{
"code": -1,
"message": "Reboot request failed"
}

eq/recreate_novnc¶

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

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=recreate_novnc" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"

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

{
"result": "OK",
"action": "recreate_novnc",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

{
"code": -1,
"message": "NoVNC recreate console request failed"
}

eq/remove_ipmi_user¶

Удаляет дополнительные учетные записи пользователей IPMI.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=remove_ipmi_user" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"

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

{
"result": "OK",
"action": "remove_ipmi_user",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

{
"code": -1,
"message": "Action error message"
}

eq/request_backup_link¶

Запрашивает временную ссылку для скачивания резервной копии.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `request_backup_link`
token	✅	string	Токен авторизации
id	✅	integer	ID сервера (eq_id)
name	✅	string	Имя бэкапа (backup name)

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=request_backup_link" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE" \
--data "name=VALUE"

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

{
"result": "OK",
"module": "eq",
"action": "request_backup_link",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

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

eq/restore_backup¶

Запускает процесс восстановления сервера из выбранной резервной копии.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=restore_backup" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE" \
--data "name=VALUE"

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

{
"result": "OK",
"module": "eq",
"action": "restore_backup",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

{
"code": -1,
"message": "Restore request failed"
}

eq/search¶

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

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `search`
token	✅	string	Токен авторизации
id	❌	`array<integer>`	ID сервера. Принимает несколько значений: id[]=val1&id[]=val2
group	❌	`array<string>`	Группа оборудования. Принимает несколько значений: group[]=val1&group[]=val2
dc	❌	`array<integer>`	ID датацентра. Принимает несколько значений: dc[]=val1&dc[]=val2
location	❌	`array<string>`	Код локации (например, RU, NL). Принимает несколько значений: location[]=val1&location[]=val2
rack	❌	`array<integer>`	ID стойки. Принимает несколько значений: rack[]=val1&rack[]=val2
status	❌	`array<string>`	Статус оборудования. Принимает несколько значений: status[]=val1&status[]=val2
owner	❌	`array<string>`	Владелец. Принимает несколько значений: owner[]=val1&owner[]=val2
component	❌	`array<integer>`	ID компонента. Принимает несколько значений: component[]=val1&component[]=val2
type	❌	`array<string>`	Тип оборудования. Принимает несколько значений: type[]=val1&type[]=val2
ip	❌	`array<string>`	IP адрес. Принимает несколько значений: ip[]=val1&ip[]=val2
mac	❌	`array<string>`	MAC адрес. Принимает несколько значений: mac[]=val1&mac[]=val2
account_id	❌	`array<integer>`	ID аккаунта. Принимает несколько значений: account_id[]=val1&account_id[]=val2
billing	❌	`array<string>`	Язык биллинга (en/ru). Принимает несколько значений: billing[]=val1&billing[]=val2
email	❌	`array<string>`	Email пользователя. Принимает несколько значений: email[]=val1&email[]=val2
name_client	❌	`array<string>`	Имя клиента. Принимает несколько значений: name_client[]=val1&name_client[]=val2
full	❌	`array<boolean>`	Полная выдача данных. Принимает несколько значений: full[]=val1&full[]=val2
kvm	❌	`array<boolean>`	Наличие KVM. Принимает несколько значений: kvm[]=val1&kvm[]=val2
serialNumber	❌	`array<string>`	Серийный номер. Принимает несколько значений: serialNumber[]=val1&serialNumber[]=val2

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=search" \
--data "token=YOUR_TOKEN" \
--data "location[]=RU" \
--data "location[]=NL" \
--data "status[]=rent"

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

{
"servers": [
{
"id": 123,
"name_server": "srv-01",
"owner": "Hostkey",
"status": "rent",
"type": "Server",
"project_ids": [],
"mounted_iso": "",
"ipmi_model": "none",
"is_prebill": false,
"is_owner": ""
}
]
}

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

{
"code": -2,
"message": "Invalid hash"
}

eq/sensors¶

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

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=sensors" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"

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

{
"result": "OK",
"action": "sensors",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

{
"code": -1,
"message": "Sensors request failed"
}

eq/set_pin¶

Устанавливает новый PIN-код для доступа к управлению сервером.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `set_pin`
token	✅	string	Токен авторизации
id	✅	integer	ID сервера
new_pin	✅	string	Новый PIN-код. Допустимая длина: от 4 до 10 символов.
old_pin	❌	string	Старый PIN-код для подтверждения операции.
no_pin_req	❌	boolean	Отключить проверку PIN-кода (если применимо).
key	❌	string	Идентификатор или ключ для выполнения операции.

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=set_pin" \
--data "token=HOSTKEY_TOKEN" \
--data "id=12345" \
--data "new_pin=1234"

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

{
"result": "OK",
"action": "set_pin",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

{
"code": -1,
"message": "invalid PIN length"
}

eq/show¶

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

HTTP-метод: GET

Параметры:

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

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

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

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

{
"result": "OK",
"server_data": {
"id": 123,
"status": "rent",
"hostname": "srv-01.hostkey.com",
"owner": "user@example.com",
"type": "Server",
"Condition_Component": "power_off",
"location": {
"dc_id": 1,
"dc_name": "Amsterdam",
"dc_location": "NL"
},
"days_left": "",
"due_date": "",
"project_ids": [],
"is_prebill": false,
"prebill_service_id": null,
"name_client": "Client Name",
"emergency": {
"active": false
}
},
"hardware": {
"cpu": "Intel Xeon E5-2680",
"ram": 64,
"hdd": 1000
},
"groups": [
{
"tag": "group_name",
"value": "val"
}
],
"licenses": [],
"reinstall": "",
"location": {
"dc_id": 1,
"dc_location": "NL"
},
"OS": {
"id": 312,
"name": "Ubuntu 22.04"
},
"IP": [
{
"IP": "192.168.1.1",
"status": "active",
"tags": []
}
],
"interfaces": [],
"IPMI": {
"model": "none",
"interfaces": [],
"user": "",
"password": "",
"white_ip": "",
"ip_acl": "",
"rule_id": ""
},
"tags": [
{
"tag": "server_id",
"value": "123"
}
],
"preset": "",
"commitment": "",
"emergency": {
"active": false,
"node_id": null,
"started_at": null
},
"preset_description": ""
}

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

{
"code": -1,
"message": "Nothing found for 123"
}

eq/status¶

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

HTTP-метод: GET

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X GET \
--data "action=status" \
--data "token=HOSTKEY_TOKEN" \
--data "id=12345"

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

{
"result": "OK",
"action": "status",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

{
"code": -1,
"message": "EQ/status: invalid server id"
}

eq/status_check¶

Возвращает общую информацию о состоянии системы.

HTTP-метод: GET

Параметры:

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

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

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

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

{
"result": "OK",
"action": "status_check",
"data": [
"string"
]
}

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

{
"code": -2,
"message": "Invalid hash"
}

eq/stop_novnc¶

Завершает текущую сессию NoVNC для сервера.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=stop_novnc" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"

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

{
"result": "OK",
"action": "stop_novnc",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

{
"code": -1,
"message": "NoVNC console terminate request failed"
}

eq/suspend¶

Приостанавливает работу сервера (для VPS).

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=suspend" \
--data "token=HOSTKEY_TOKEN" \
--data "id=12345"

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

{
"result": "OK",
"action": "suspend",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

{
"code": -1,
"message": "Suspend request failed"
}

eq/traffic_add¶

Запрашивает увеличение лимита исходящего трафика и создает инвойс.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `traffic_add`
token	✅	string	Токен авторизации
id	✅	integer	ID сервера
new_limit	✅	number	Новый лимит трафика (в ТБ). Должен быть больше текущего потребления.

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=traffic_add" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE" \
--data "new_limit=VALUE"

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

{
"result": "OK",
"module": "eq",
"action": "traffic_add",
"invoice": 12345,
"status": "Unpaid"
}

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

{
"code": -1,
"message": "EQ/traffic_add: invalid new_limit"
}

eq/unit_reset¶

Запрашивает сброс устройства (IPMI reset) для указанного сервера.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=unit_reset" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"

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

{
"result": "OK",
"action": "unit_reset",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

{
"code": -1,
"message": "IPMI unit reset request failed: error_details"
}

eq/suspend¶

Запрашивает блокировку (suspension) VPS/сервера.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=suspend" \
--data "token=HOSTKEY_TOKEN" \
--data "id=12345"

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

{
"result": "OK",
"action": "suspend",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

{
"code": -1,
"message": "Suspend request failed"
}

eq/unsuspend¶

Запрашивает разблокировку (unsuspension) VPS/сервера.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=unsuspend" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"

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

{
"result": "OK",
"action": "unsuspend",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

{
"code": -1,
"message": "Unsuspend request failed"
}

eq/check_pin¶

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

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=check_pin" \
--data "token=HOSTKEY_TOKEN" \
--data "pin=VALUE" \
--data "key=VALUE"

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

{
"result": "OK",
"action": "check_pin",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

{
"code": -1,
"message": "PIN validation failed"
}

eq/clear_pxe¶

Очищает PXE-конфигурацию для конкретного хоста.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=clear_pxe" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"

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

{
"result": "OK",
"action": "clear_pxe",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

{
"code": -1,
"message": "Failed to submit clear PXE config request"
}

eq/reinstall¶

Запускает процесс переустановки сервера и создает ключ для операции.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=reinstall" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"

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

{
"result": "OK",
"action": "reinstall",
"stage": "create_pxe",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

{
"code": -1,
"message": "EQ/reinstall: invalid server id"
}

eq/update_servers¶

Обновляет список активных серверов для текущего токена/аккаунта.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `update_servers`
token	✅	string	Токен авторизации
load_servers_only	❌	boolean	Загружать только серверы (true/false). Если true, исключаются серверы типа IP rent.

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=update_servers" \
--data "token=HOSTKEY_TOKEN" \
--data "load_servers_only=true"

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

{
"result": "OK",
"servers": [
101,
102
],
"billing_servers": [],
"deploy_keys": {},
"prebill_deploy_keys": [],
"prebill_pending": [],
"servers_emergency": {
"101": {
"active": true,
"node_id": 5,
"started_at": "2024-01-01T12:00:00Z"
}
}
}

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

{
"code": -1,
"message": "No active servers were found for this account",
"no_servers": 1
}