Перейти к содержанию

eq.php

Модуль управления оборудованием (eq.php): API для развертывания серверов, управления питанием, IPMI, резервными копиями, поиска и получения детальной информации о конфигурации оборудования.

Методы API

Метод Действие Описание
abort_reinstall отмена переустановки Отменяет процесс переустановки сервера, удаляет соответствующие теги и восстанавливает VLAN.
add_ipmi_admin добавление IPMI администратора Добавляет пользователя IPMI с правами администратора.
add_ipmi_user добавление IPMI пользователя Добавляет пользователя IPMI.
announceip анонсирование IP Анонсирует IP-адрес или подсеть через BGP.
backup_get_schedule получение расписания бэкапа Возвращает текущее расписание резервного копирования для сервера.
backup_list список бэкапов Возвращает список доступных резервных копий сервера.
backup_save_schedule сохранение расписания бэкапа Сохраняет новое расписание резервного копирования.
boot_dev загрузка с устройства Загружает сервер с указанного носителя (PXE или диск).
check_backup_lock проверка блокировки бэкапа Проверяет наличие блокировки на создание бэкапа.
check_pin проверка PIN Проверяет PIN-код для подтверждения действий.
clear_pxe очистка PXE Очищает конфигурацию PXE для сервера.
console запрос консоли Запрашивает доступ к консоли сервера.
create_backup создание бэкапа Инициирует создание резервной копии сервера.
create_pxe создание PXE конфигурации Создает конфигурацию PXE для переустановки сервера.
delete_backup удаление бэкапа Удаляет указанную резервную копию.
deploy развертывание сервера Развертывает сервер по ID или имени пресета.
get_ipmi получение IPMI Возвращает IPMI адрес и модель сервера.
get_traffic получение трафика Возвращает данные о трафике IPv4 для сервера.
getserversforannounce получение серверов для анонса Возвращает список серверов, доступных для анонса IP.
groups получение групп Возвращает группы, к которым принадлежит сервер.
hard_off жесткое выключение Жестко выключает сервер (отключение питания).
history история сервера Возвращает историю событий сервера.
list список оборудования Возвращает список оборудования по различным критерям поиска.
novnc запрос NoVNC Запрашивает доступ к NoVNC консоли.
off выключение сервера Выключает сервер.
on включение сервера Включает сервер.
order_instance заказ инстанса Заказывает новый сервер или переустанавливает существующий.
reboot перезагрузка сервера Перезагружает сервер.
recreate_novnc пересоздание NoVNC Пересоздает NoVNC консоль.
reinstall начало переустановки Запускает процесс переустановки сервера.
remove_ipmi_user удаление IPMI пользователя Удаляет пользователя IPMI.
request_backup_link запрос ссылки на бэкап Запрашивает ссылку для скачивания резервной копии.
restore_backup восстановление бэкапа Восстанавливает сервер из резервной копии.
search поиск оборудования Поиск оборудования по различным параметрам.
sensors получение сенсоров Возвращает данные с сенсоров сервера.
set_pin установка PIN Устанавливает PIN-код для подтверждения действий.
show показать сервер Возвращает детальную информацию о сервере и его оборудовании.
status статус сервера Возвращает текущий статус сервера.
stop_novnc остановка NoVNC Останавливает NoVNC консоль.
suspend приостановка сервера Приостанавливает сервер.
unified_server_search единый поиск серверов Единый поиск серверов по ID или имени.
unit_reset сброс IPMI Сбрасывает IPMI модуль сервера.
unsuspend снятие приостановки Снимает приостановку с сервера.
update_servers обновление списка серверов Обновляет список серверов для токена.

eq/abort_reinstall

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

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=abort_reinstall" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"
Пример успешного ответа 
{
"result": "OK",
"action": "abort_reinstall",
"id": 12345
}
Примеры ошибок 
{
"code": -1,
"message": "eq/abort_reinstall: invalid server id"
}

eq/add_ipmi_admin

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

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: add_ipmi_admin
token ✅ string Токен авторизации
id ✅ int ID сервера
admin_user ❌ string Имя пользователя администратора (обязательно для клиентов с тегом admin_ipmi)
admin_pass ❌ string Пароль администратора (обязательно, если указан admin_user)

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=add_ipmi_admin" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"
Пример успешного ответа 
{
"result": "OK",
"action": "add_ipmi_admin",
"user": "u123456",
"password": "Aa1Bb2Cc3Dd4Ee5F"
}
Примеры ошибок 
{
"code": -1,
"message": "invalid server id"
}

eq/add_ipmi_user

Добавляет пользователя IPMI.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=add_ipmi_user" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"
Пример успешного ответа 
{
"result": "OK",
"action": "add_ipmi_user",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}
Примеры ошибок 
{
"code": -1,
"message": "invalid server id"
}

eq/announceip

Анонсирует IP-адрес или подсеть через BGP.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: announceip
token ✅ string Токен авторизации
id ✅ int ID сервера
subnet ❌ string Подсеть
server ❌ string Сервер
subnetaddr ❌ string Адрес подсети
subnetaddrmask ❌ string Маска адреса подсети
asn ❌ string ASN (или 'own' для собственного)
ownasn ❌ string Собственный ASN
annonce ❌ string Анонс
return ❌ string Возврат
route ❌ string Маршрут
cmnt ❌ string Комментарий
ASRegistered ✅ int Чекбокс: AS зарегистрирован (1 или 0)
RKPIValid ✅ int Чекбокс: RKPI валиден (1 или 0)
SubNetNotSpamhaus ✅ int Чекбокс: Подсеть не в Spamhaus (1 или 0)
DataIsCorrect ✅ int Чекбокс: Данные верны (1 или 0)

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=announceip" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE" \
--data "ASRegistered=VALUE" \
--data "RKPIValid=VALUE" \
--data "SubNetNotSpamhaus=VALUE" \
--data "DataIsCorrect=VALUE"
Пример успешного ответа 
{
"result": "OK",
"module": "eq",
"action": "announceip"
}
Примеры ошибок 
{
"code": -1,
"message": "invalid request"
}

eq/backup_get_schedule

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

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=backup_get_schedule" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"
Пример успешного ответа 
{
"result": "OK",
"module": "eq",
"action": "backup_get_schedule",
"schedule": {
"days": [
0,
0,
0,
0,
0,
0,
0
],
"time": "",
"timezone": ""
}
}
Примеры ошибок 
{
"code": -1,
"message": "invalid server id"
}

eq/backup_list

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

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=backup_list" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"
Пример успешного ответа 
{
"result": "OK",
"module": "eq",
"action": "backup_list",
"data": [
{
"name": "backup_20231025",
"size": 1024000,
"date": "2023-10-25 10:00:00"
}
]
}
Примеры ошибок 
{
"code": -1,
"message": "invalid server id"
}

eq/backup_save_schedule

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

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: backup_save_schedule
token ✅ string Токен авторизации
id ✅ int ID сервера
backup_schedule ✅ object Объект расписания резервного копирования

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=backup_save_schedule" \
--data "token=HOSTKEY_TOKEN" \
--data "id=12345" \
--data "backup_schedule[days][]="1" \
--data "backup_schedule[days][]="1" \
--data "backup_schedule[days][]="1" \
--data "backup_schedule[days][]="1" \
--data "backup_schedule[days][]="1" \
--data "backup_schedule[days][]="0" \
--data "backup_schedule[days][]="0" \
--data "backup_schedule[time]="02:00" \
--data "backup_schedule[timezone]="Europe/Moscow"
Пример успешного ответа 
{
"result": "OK",
"module": "eq",
"action": "backup_save_schedule"
}
Примеры ошибок 
{
"code": -1,
"message": "invalid server id"
}

eq/boot_dev

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

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=boot_dev" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE" \
--data "media=VALUE"
Пример успешного ответа 
{
"result": "OK",
"action": "boot_dev",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}
Примеры ошибок 
{
"code": -1,
"message": "EQ/boot_dev: missing media type"
}

eq/check_backup_lock

Проверяет наличие блокировки на создание бэкапа.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: check_backup_lock
token ✅ string Токен авторизации
id ✅ int 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": "invalid server id"
}

eq/check_pin

Проверяет PIN-код для подтверждения действий.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=check_pin" \
--data "token=HOSTKEY_TOKEN" \
--data "pin=VALUE"
Пример успешного ответа 
{
"result": "OK",
"action": "check_pin",
"callback": "pin_disabled"
}
Примеры ошибок 
{
"code": -1,
"message": "PIN validation failed"
}

eq/clear_pxe

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

HTTP-метод: POST

Параметры:

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

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

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/console

Запрашивает доступ к консоли сервера.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: console
token ✅ string Токен авторизации
id ✅ int 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": "Console request failed"
}

eq/create_backup

Инициирует создание резервной копии сервера.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: create_backup
token ✅ string Токен авторизации
id ✅ int 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": "550e8400-e29b-41d4-a716-446655440000"
}
Примеры ошибок 
{
"code": -1,
"message": "invalid server id"
}

eq/create_pxe

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

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: create_pxe
token ✅ string Токен авторизации
id ✅ int ID сервера
os_id ✅ int ID операционной системы
os_name ❌ string Имя ОС (альтернатива os_id)
root_pass ✅ string Пароль root
hostname ✅ string Имя хоста
ssh_key ❌ string SSH ключ
post_install_script ❌ string Скрипт пост-установки
post_install_callback ❌ string URL для callback
disk_mirror ❌ int Тип зеркалирования диска
root_size ❌ int Размер корневой分区
uefi ❌ int Использовать UEFI
custom_domain ❌ string Кастомный домен
reinstall_key ❌ string Ключ переустановки
email ❌ string Email пользователя
no_lvm ❌ string Отключить LVM
manual_choice_dsk ❌ int Ручной выбор диска
attendedInstall ❌ int Использовать attended install
ignore_duplicated_install ❌ int Игнорировать дубликаты установки (только для администраторов)
deploy_ticket ❌ string ID тикета для деплоя (только для администраторов)

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=create_pxe" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE" \
--data "os_id=VALUE" \
--data "root_pass=VALUE" \
--data "hostname=VALUE"
Пример успешного ответа 
{
"result": "OK",
"action": "create_pxe",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}
Примеры ошибок 
{
"code": -1,
"message": "Create PXE config request failed"
}

eq/delete_backup

Удаляет указанную резервную копию.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=delete_backup" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE" \
--data "name=VALUE"
Пример успешного ответа 
{
"result": "OK",
"module": "eq",
"action": "delete_backup",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}
Примеры ошибок 
{
"code": -1,
"message": "invalid server id"
}

eq/deploy

Развертывает сервер по ID или имени пресета.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: deploy
token ✅ string Токен авторизации
id ❌ int ID сервера
preset ❌ string Имя пресета
location ❌ int ID локации
os_id ✅ int ID ОС
root_pass ✅ string Пароль root
hostname ❌ string Имя хоста
ssh_key ❌ string SSH ключ
post_install_script ❌ string Скрипт пост-установки
post_install_callback ❌ string URL для callback
deploy_data ✅ string Данные биллинга
deploy_options ✅ string Опции биллинга
traffic_plan ✅ int ID тарифа трафика
disk_mirror ❌ int Тип зеркалирования
root_size ❌ int Размер корневой分区
ipv4_amount ❌ int Количество IPv4
custom_domain ❌ string Кастомный домен
deploy_ticket ❌ string ID тикета для развертывания
deploy_price ❌ string Цена развертывания
deploy_period ❌ string Период биллинга
deploy_notify ❌ string Флаг уведомлений
imitate_deploy ❌ string Флаг имитации развертывания
imitate_error ❌ string Флаг имитации ошибки
own_os ❌ string Флаг собственной ОС
jenkins_task ❌ string ID задачи Jenkins
jenkins_tests ❌ string Флаг тестов Jenkins
deploy_comment ❌ string Комментарий к развертыванию
invoice_relid ❌ int ID элемента счета
activate_windows ❌ int Флаг активации Windows
uefi ❌ string Флаг UEFI
attendedInstall ❌ string Флаг attended установки
manual_choice_dsk ❌ string Флаг ручного выбора диска
no_lvm ❌ string Флаг отключения LVM

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=deploy" \
--data "token=HOSTKEY_TOKEN" \
--data "os_id=VALUE" \
--data "root_pass=VALUE" \
--data "deploy_data=VALUE" \
--data "deploy_options=VALUE" \
--data "traffic_plan=VALUE"
Пример успешного ответа 
{
"result": "OK",
"action": "deploy",
"callback": "7bc29eb23fb1b879b21fce509597f07c",
"ticket": 12345
}
Примеры ошибок 
{
"code": -1,
"message": "Deploy init for server failed"
}

eq/get_ipmi

Возвращает IPMI адрес и модель сервера.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=get_ipmi" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"
Пример успешного ответа 
{
"result": "OK",
"ipmi": [
{
"IP": "192.168.1.100",
"MAC": "00:11:22:33:44:55",
"vendor": "Supermicro"
}
]
}
Примеры ошибок 
{
"code": -1,
"message": "No IPMI interfaces found"
}

eq/get_traffic

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

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=get_traffic" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"
Пример успешного ответа 
{
"result": "OK",
"module": "eq",
"action": "get_traffic",
"id": 12345,
"traffic": [
{
"ip": "192.168.1.1",
"volume": 104857600,
"updated": "2023-10-25",
"billed": 1,
"direction": "out"
},
{
"ip": "192.168.1.1",
"volume": 52428800,
"updated": "2023-10-25",
"billed": 1,
"direction": "in"
}
]
}
Примеры ошибок 
{
"code": -1,
"message": "eq_get_traffic: invalid server id"
}

eq/getserversforannounce

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

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=getserversforannounce" \
--data "token=HOSTKEY_TOKEN"
Пример успешного ответа 
{
"result": "OK",
"module": "eq",
"action": "getserversforannounce",
"servers": [
{
"id": 123,
"location": "NL",
"mask_23": true,
"mask_24": false
}
]
}
Примеры ошибок 
{
"code": -2,
"message": "Authentication required"
}

eq/groups

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

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=groups" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"
Пример успешного ответа 
{
"result": "OK",
"groups": [
"group1",
"group2"
]
}
Примеры ошибок 
{
"code": -1,
"message": "EQ/groups: invalid server id"
}

eq/hard_off

Жестко выключает сервер (отключение питания).

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=hard_off" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"
Пример успешного ответа 
{
"result": "OK",
"action": "hard_off",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}
Примеры ошибок 
{
"code": -1,
"message": "Stop request failed"
}

eq/history

Возвращает историю событий сервера.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: history
token ✅ string Токен авторизации
id ✅ int ID сервера
type ❌ string Тип событий
date_from ❌ string Дата начала
date_to ❌ string Дата конца

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=history" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"
Пример успешного ответа 
{
"result": "OK",
"module": "eq",
"action": "history",
"id": 12345,
"history": [
{
"date": "2023-10-25 10:00:00",
"message": "Server rebooted",
"type": "action"
}
]
}
Примеры ошибок 
{
"code": 400,
"message": "Invalid server id"
}

eq/list

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

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: list
token ✅ string Токен авторизации
group ❌ string Группа оборудования
location ❌ string Локация (RU, NL и т.д.)
status ❌ string Статус оборудования
type ❌ string Тип оборудования
ip ❌ string IP адрес
id ❌ int ID сервера
full ❌ int Полная информация
dc ❌ string ID датацентра
rack ❌ string ID стойки
owner ❌ string Владелец
component ❌ string ID компонента оборудования
mac ❌ string MAC адрес
account_id ❌ string ID биллинга
billing ❌ string Биллинг (en/ru)
email ❌ string Email владельца
name_client ❌ string Имя клиента
kvm ❌ string KVM
serialNumber ❌ string Серийный номер

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=list" \
--data "token=HOSTKEY_TOKEN"
Пример успешного ответа 
{
"result": "OK",
"servers": [
{
"id": 123,
"name": "server1",
"status": "rent",
"location": "NL",
"type": "Server",
"owner": "Hostkey",
"ip": "192.168.1.1",
"mac": "00:11:22:33:44:55",
"serialNumber": "SN123456",
"project_ids": [
1,
2
],
"is_prebill": false,
"days_left": 30,
"due_date": "2023-12-31",
"techAssigned": "admin",
"cost_trafficIN": 1000,
"limit_trafficIN": 5000,
"cost_traffic": 10,
"limit_traffic": 10000,
"account_id": 555,
"limit_bands": 1000,
"IsShape": 1,
"trafficPeriodOut": 100,
"trafficPeriodIn": 200,
"trafficPeriodOutBilling": 100,
"trafficPeriodInBilling": 200,
"datePeriod": "2023-01-01",
"hwconfig": "config_data",
"server_contacts": "contact1",
"sla_level": "gold"
}
]
}
Примеры ошибок 
{
"code": -1,
"message": "Query error"
}

eq/novnc

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

HTTP-метод: POST

Параметры:

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

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

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

Выключает сервер.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=off" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"
Пример успешного ответа 
{
"result": "OK",
"action": "off",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}
Примеры ошибок 
{
"code": -1,
"message": "Stop request failed"
}

eq/on

Включает сервер.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=on" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"
Пример успешного ответа 
{
"result": "OK",
"action": "on",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}
Примеры ошибок 
{
"code": -1,
"message": "Start request failed"
}

eq/order_instance

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

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: order_instance
token ✅ string Токен авторизации
id ❌ int ID сервера (для переустановки)
preset ❌ string Имя пресета
location_name ✅ string Название локации
os_id ✅ int ID ОС
os_name ❌ string Имя ОС
root_pass ✅ string Пароль root
hostname ❌ string Имя хоста
ssh_key ❌ string SSH ключ
post_install_script ❌ string Скрипт пост-установки
post_install_callback ❌ string URL для callback
traffic_plan ✅ int ID тарифа трафика
ipv4_amount ❌ int Количество IPv4
deploy_period ❌ string Период биллинга
promocode ❌ string Промокод
custom_domain ❌ string Кастомный домен
currency_code ❌ string Код валюты
os_template ❌ string Шаблон ОС
soft_id ❌ int ID дополнительного ПО
vlan ❌ string ID приватной VLAN
ip ❌ string Приватный IP адрес
root_size ❌ int Размер корневой分区
disk_mirror ❌ int Тип зеркалирования диска
deploy_data ❌ string Данные для биллинга (email или invoice_id)
deploy_options ❌ string Опции биллинга
deploy_notify ❌ int Отправлять уведомления
deploy_ticket ❌ string ID тикета для деплоя
deploy_comment ❌ string Комментарий к деплою
imitate_deploy ❌ int Имитация деплоя
imitate_error ❌ int Имитация ошибки
own_os ❌ int Использовать собственную ОС
jenkins_task ❌ string Задача Jenkins
jenkins_tests ❌ int Тесты Jenkins
invoice_relid ❌ int relid инвойса
activate_windows ❌ int Активировать Windows
uefi ❌ int Использовать UEFI
attendedInstall ❌ int Установить с участием
no_lvm ❌ string Отключить LVM
cloud_init_script ❌ string Скрипт Cloud-Init
reinstall_key ❌ string Ключ переустановки
email ❌ string Email пользователя
deploy_price ❌ string Цена деплоя
deploy_method ❌ string Метод деплоя
private_ip ❌ string Приватный IP
private_vlan ❌ string Приватная VLAN
ram ❌ int Объем RAM
cpu ❌ int Количество CPU
hdd ❌ int Объем HDD
os_name_foreman ❌ string Имя ОС в Foreman
is_vm_storage ❌ bool Является ли VM storage
os_license_id ❌ int ID лицензии ОС
soft_name ❌ string Имя ПО
template ❌ string Шаблон
engine ❌ string Движок
cluster ❌ string Кластер
openstack_template_id ❌ string ID шаблона OpenStack
openstack_image_id ❌ string ID образа OpenStack
openstack_network_id ❌ string ID сети OpenStack
openstack_vm_id ❌ string ID VM OpenStack
billing ❌ string Биллинг
prebill ❌ int Предоплата
service_id ❌ int ID сервиса
hwconfig ❌ string Конфигурация оборудования
promo_discount ❌ float Скидка промокода
corp ❌ string Корпоративный клиент
discount ❌ float Скидка
currency ❌ string Валюта
product ❌ string Продукт
description ❌ string Описание
account_id ❌ int ID аккаунта
customer_id ❌ int ID клиента
service_type ❌ int Тип сервиса
project_id ❌ int ID проекта
total ❌ float Сумма
location ❌ string Локация
vm_id ❌ int ID VM
deploy_ticket ❌ string ID тикета деплоя
deploy_status ❌ string Статус деплоя
callback ❌ string Ключ обратного вызова
invoice ❌ int ID инвойса
status ❌ string Статус
invoice_details ❌ object Детали инвойса
prebill_message ❌ string Сообщение предоплаты

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=order_instance" \
--data "token=HOSTKEY_TOKEN" \
--data "location_name=VALUE" \
--data "os_id=VALUE" \
--data "root_pass=VALUE" \
--data "traffic_plan=VALUE"
Пример успешного ответа 
{
"result": "OK",
"action": "order_instance",
"callback": "7bc29eb23fb1b879b21fce509597f07c",
"deploy_status": "install",
"id": 12345,
"os_name": "Ubuntu 22.04",
"soft_name": "cPanel",
"invoice": 98765,
"status": "Unpaid",
"invoice_details": {
"id": 98765,
"status": "Unpaid",
"amount": 100.0
}
}
Примеры ошибок 
{
"code": -1,
"message": "OS not compatible with preset"
}

eq/reboot

Перезагружает сервер.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: reboot
token ✅ string Токен авторизации
id ✅ int 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 ✅ int 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/reinstall

Запускает процесс переустановки сервера.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: reinstall
token ✅ string Токен авторизации
id ✅ int 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/remove_ipmi_user

Удаляет пользователя IPMI.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: remove_ipmi_user
token ✅ string Токен авторизации
id ✅ int 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": "remove_ipmi_user: invalid server id"
}

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

HTTP-метод: POST

Параметры:

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

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

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": "invalid server id"
}

eq/restore_backup

Восстанавливает сервер из резервной копии.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: restore_backup
token ✅ string Токен авторизации
id ✅ int 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": "invalid server id"
}

eq/search

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

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: search
token ✅ string Токен авторизации
group ❌ string Группа оборудования
dc ❌ string ID датацентра
location ❌ string Локация (RU, NL и т.д.)
rack ❌ string ID стойки
status ❌ string Статус оборудования
owner ❌ string Владелец
component ❌ string ID компонента оборудования
type ❌ string Тип оборудования
ip ❌ string IP адрес
mac ❌ string MAC адрес
account_id ❌ string ID биллинга
billing ❌ string Биллинг (en/ru)
email ❌ string Email владельца
name_client ❌ string Имя клиента
full ❌ string Полная информация
kvm ❌ string KVM статус
serialNumber ❌ string Серийный номер
id ❌ string ID оборудования

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=search" \
--data "token=HOSTKEY_TOKEN"
Пример успешного ответа 
{
"result": "OK",
"servers": [
{
"id": 123,
"name": "server1",
"status": "rent",
"location": "RU",
"type": "Server",
"owner": "Hostkey",
"ip": "192.168.1.1"
}
]
}
Примеры ошибок 
{
"code": -1,
"message": "Query error"
}

eq/sensors

Возвращает данные с сенсоров сервера.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: sensors
token ✅ string Токен авторизации
id ✅ int 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 Токен авторизации
new_pin ✅ string Новый PIN (4-10 символов)
old_pin ❌ string Старый PIN
no_pin_req ❌ string Флаг отключения требования PIN

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=set_pin" \
--data "token=HOSTKEY_TOKEN" \
--data "new_pin=VALUE"
Пример успешного ответа 
{
"result": "OK",
"action": "set_pin",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}
Примеры ошибок 
{
"code": -1,
"message": "invalid PIN length"
}

eq/show

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

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=show" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"
Пример успешного ответа 
{
"result": "OK",
"server_data": {
"id": 123,
"status": "rent",
"Condition_Component": "rent",
"is_owner": "Hostkey",
"type_billing": "whmcs",
"account_id": 456,
"due_date": "2023-12-31",
"days_left": 15,
"hwconfig": "Supermicro X10",
"name_client": "Client Name",
"last_backup": {
"date": "2023-10-01",
"size": "500GB"
},
"sla_level": "Gold",
"server_contacts": "123,456",
"is_prebill": false,
"project_ids": [
1,
2
]
},
"hardware": {
"components": [
{
"Type": "CPU",
"Name": "Intel Xeon",
"Count": 2,
"Cores": 16
}
],
"config": "Supermicro X10",
"ram": 64,
"hdd": 2000,
"cpu_cores": 32
},
"groups": [
{
"id": 1,
"name": "Production"
}
],
"licenses": [
{
"id": 101,
"name": "Windows Server 2022",
"amount": 1,
"date_buy": "2023-01-01"
}
],
"reinstall": "",
"location": {
"dc_location": "NL",
"location_id": 5
},
"OS": {
"id": 12,
"name": "Ubuntu 22.04"
},
"IP": [
{
"IP": "192.168.1.1",
"type": "public",
"tags": []
}
],
"interfaces": [
{
"id": 1,
"type": "eth0",
"mac": "00:11:22:33:44:55",
"upstream_id": 10,
"IsMain": true,
"IsVirt": false,
"Status": "up",
"switch_owner": "Hostkey",
"switch_model": "Cisco",
"port_of_virt_node": 0,
"tags": []
}
],
"IPMI": {
"model": "Supermicro",
"interfaces": [
{
"IP": "192.168.1.100",
"MAC": "AA:BB:CC:DD:EE:FF"
}
],
"user": "",
"password": "",
"white_ip": "",
"ip_acl": "",
"rule_id": ""
},
"tags": [
{
"tag": "preset",
"value": "10",
"extra": "Standard",
"internal": 0
}
],
"preset": "Standard",
"preset_description": "Standard server configuration",
"commitment": "12 months"
}
Примеры ошибок 
{
"code": -1,
"message": "Nothing found for id"
}

eq/status

Возвращает текущий статус сервера.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=status" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"
Пример успешного ответа 
{
"result": "OK",
"action": "status",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}
Примеры ошибок 
{
"code": -1,
"message": "Status request failed"
}

eq/stop_novnc

Останавливает NoVNC консоль.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: stop_novnc
token ✅ string Токен авторизации
id ✅ int 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

Приостанавливает сервер.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=suspend" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"
Пример успешного ответа 
{
"result": "OK",
"action": "suspend",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}
Примеры ошибок 
{
"code": -1,
"message": "Suspend request failed"
}

Единый поиск серверов по ID или имени.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=unified_server_search" \
--data "token=HOSTKEY_TOKEN" \
--data "query=VALUE"
Пример успешного ответа 
{
"result": "OK",
"results": {
"servers": [
{
"id": 123,
"name": "server1",
"owner": "customer@example.com",
"status": "rent",
"billing": "whmcs",
"sla_level": "gold",
"type": "server"
}
]
},
"limited": {
"servers": false
},
"category": "servers"
}
Примеры ошибок 
{
"code": -2,
"message": "Authentication required"
}

eq/unit_reset

Сбрасывает IPMI модуль сервера.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: unit_reset
token ✅ string Токен авторизации
id ✅ int 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"
}

eq/unsuspend

Снимает приостановку с сервера.

HTTP-метод: POST

Параметры:

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

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

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/update_servers

Обновляет список серверов для токена.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: update_servers
token ✅ string Токен авторизации
load_servers_only ❌ string Если 'true', возвращает только ID серверов, исключая 'IP rent'

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=update_servers" \
--data "token=HOSTKEY_TOKEN"
Пример успешного ответа 
{
"result": "OK",
"servers": [
123,
456
],
"billing_servers": [
{
"id": 789,
"config": "",
"status": "Pending",
"regdate": "2023-10-01",
"name": "Server Name",
"recurring": 1,
"nextduedate": "2023-11-01",
"billingcycle": "Monthly"
}
],
"deploy_keys": {
"123": "abc123def456"
}
}
Примеры ошибок 
{
"code": -1,
"message": "Failed to retrive servers list, billing error: ..."
}
question_mark
Я могу вам чем-то помочь?
question_mark
ИИ Помощник ×