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

eq.php

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

Методы API

Метод Действие Описание
abort_reinstall прерывание переустановки Прекращает процесс переустановки сервера, удаляет связанные теги (reinstall_start, autodeploy_start, autodeploy_timeout) и восстанавливает настройки 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 проверка блокировки бэкапа Проверяет наличие активной блокировки на выполнение операций резервного копирования для указанного сервера.
clear_pxe очистка PXE конфигурации Очищает текущую PXE конфигурацию для указанного хоста
create_backup создание резервной копии Инициирует процесс создания резервной копии для указанного сервера. Операция выполняется асинхронно.
create_pxe подготовка PXE конфигурации для переустановки Запрашивает создание PXE-конфигурации для последующей переустановки ОС на сервере. Возвращает callback для отслеживания процесса.
delete_backup удаление бэкапа Удаляет указанный бэкап сервера. Требует выполнения асинхронной задачи.
deploy развертывание сервера Запускает процесс развертывания (деплоя) выбранного сервера или пресета. Поддерживает выбор ОС, настройку hostname, SSH-ключей и скриптов post-install.
get_ipmi получение данных IPMI Возвращает IP-адрес и модель интерфейса IPMI для указанного сервера. Может возвращать несколько интерфейсов.
get_traffic получение данных о трафике Возвращает данные об использовании IPv4 трафика для указанного сервера
getserversforannounce получение списка серверов для анонса Возвращает список доступных (rent/power_off) серверов пользователя, подходящих под ограничения по маскам IPv4 (/23 и /24), которые можно использовать для анонсирования IP-адресов.
groups получение групп Возвращает список групп для конкретного сервера
hard_off принудительное выключение сервера Выполняет принудительное (жесткое) выключение оборудования по указанному ID.
history история Возвращает историю событий сервера.
list получение списка оборудования Возвращает список доступного оборудования с возможностью фильтрации по различным параметрам (локация, статус, тип и др.)
off выключение Выключает сервер.
on включение Включает сервер.
order_instance заказ инстанса/переустановка Запуск процесса развертывания нового сервера из пресета или переустановки существующего сервера с выбором ОС и дополнительного ПО.
reboot перезагрузка сервера Отправляет запрос на перезагрузку указанного сервера. Если сервер принадлежит клиенту, проверяется наличие блокировки (lock).
reinstall инициализация переустановки Создает ключ для начала процесса переустановки сервера и устанавливает начальную стадию (create_pxe).
remove_ipmi_user удаление пользователя IPMI Удаляет дополнительного пользователя IPMI для указанного сервера.
request_backup_link запрос ссылки на бэкап Запрашивает генерацию временной ссылки для скачивания резервной копии сервера.
restore_backup восстановление из бэкапа Запускает процесс восстановления сервера из указанного бэкапа. Операция асинхронная.
search поиск оборудования Возвращает список доступных серверов и инстансов по различным критериям фильтрации (локация, статус, тип, IP, MAC и др.)
sensors получение данных сенсоров Возвращает текущие показания сенсоров для указанного сервера
show получение данных о сервере Возвращает полные данные о сервере, включая аппаратную конфигурацию (hwconfig), операционную систему, IP-адреса, интерфейсы и IPMI.
status получение статуса Возвращает текущий статус оборудования (power_off, rent, TT и др.) и связанные с ним данные
suspend приостановка сервера Запрашивает приостановку (suspend) или разблокировку (unsuspend) VPS/сервера. Если действие suspend, сервер будет заблокирован.
unified_server_search единый поиск серверов Единый поиск серверов по запросу.
unit_reset сброс IPMI Запрашивает сброс модуля IPMI для указанного сервера.
unsuspend разблокировка сервера Запрос на снятие блокировки (unsuspend) с сервера. Если запрос прошел успешно, сервер будет разблокирован.
update_servers обновление списка серверов для пользователя Обновляет список доступных серверов, привязанных к аккаунту клиента в WHMCS, включая проверку активных услуг и пребилл-серверов.

eq/abort_reinstall

Прекращает процесс переустановки сервера, удаляет связанные теги (reinstall_start, autodeploy_start, autodeploy_timeout) и восстанавливает настройки 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=123"
Пример успешного ответа
{
"result": "OK",
"action": "abort_reinstall",
"id": 123
}
Примеры ошибок

``` { "code": -1, "message": "\(module/\)action: invalid server id" }

```

eq/add_ipmi_admin

Создает нового пользователя с правами администратора для управления через IPMI. Если пользователь уже существует, возвращает его данные.

HTTP-метод: POST

Параметры:

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

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

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

``` { "code": -1, "message": "Add IPMI user request failed" }

```

eq/add_ipmi_user

Добавляет нового пользователя в систему управления IPMI для конкретного сервера. Если пользователь является администратором, параметры могут быть переопределены.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action string Идентификатор метода: add_ipmi_user
token string Токен авторизации
id integer 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=12345" \
--data "admin_user=admin" \
--data "admin_pass=password"
Пример успешного ответа
{
"result": "OK",
"action": "add_ipmi_user",
"callback": "string"
}
Примеры ошибок

``` { "code": -1, "message": "Add IPMI user request failed" }

```

eq/announceip

Выполняет анонс указанной подсети или IP-адреса через BGP. Поддерживает проверку прав доступа и работу с субсчетами.

HTTP-метод: POST|GET

Параметры:

Параметр Обязательный Тип Описание
action string Идентификатор метода: announceip
token string Токен авторизации
id integer ID сервера/объекта
subnet string Подсеть для анонса
server string Сервер (boolean/string)
subnetaddr string Адрес в подсети
subnetaddrmask string Маска адреса в подсети
asn string Номер автономной системы (можно 'own')
ownasn boolean Использовать собственный ASN
annonce boolean Флаг анонса
return boolean Возвращать результат
route boolean Флаг маршрутизации
cmnt string Комментарий к анонсу
checkboxes boolean Подтверждение условий (ASRegistered, RKPIValid, SubNetNotSpamhaus, DataIsCorrect)

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=announceip" \
--data "id=123" \
--data "subnet=1.2.3.0/24" \
--data "asn=own"
Пример успешного ответа
{
"result": "OK",
"module": "eq",
"action": "announceip"
}
Примеры ошибок

``` { "code": -2, "message": "EQ: action required" }

```

eq/backup_get_schedule

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

HTTP-метод: GET

Параметры:

Параметр Обязательный Тип Описание
action string Идентификатор метода: backup_get_schedule
token string Авторизационный токен
id int 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": "eq",
"action": "backup_get_schedule",
"days": [0, 0, 0, 0, 0, 0, 0],
"time": "",
"timezone": ""
}
Примеры ошибок

``` { "code": -2, "message": "Authentication required" }

```

eq/backup_list

Возвращает список доступных резервных копий для указанного оборудования (сервера)

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=backup_list" \
--data "id=VALUE"
Пример успешного ответа
{
"result": "OK",
"module": "eq",
"action": "backup_list",
"data": [
{
"bucket_name": "example-bucket",
"files": []
}
]
}
Примеры ошибок

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

```

eq/backup_save_schedule

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

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action string Идентификатор метода: backup_save_schedule
token string Токен авторизации
id integer ID сервера
backup_schedule array Массив настроек расписания бэкапов (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[0][days]=mon,wed,fri" \
--data "backup_schedule[0][time]=03:00" \
--data "backup_schedule[0][timezone]=UTC"
Пример успешного ответа
{
"result": "OK",
"action": "backup_save_schedule"
}
Примеры ошибок

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

```

eq/boot_dev

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

HTTP-метод: POST|GET

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq" -X POST \
--data "action=boot_dev" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "media=pxe" \
--data "boot_mode=uefi"
Пример успешного ответа
{
"result": "OK",
"action": "boot_dev",
"callback": "string"
}
Примеры ошибок

``` { "code": -1, "message": "Bootable media change request failed: [ошибка]" }

```

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",
"action": "check_backup_lock",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}
Примеры ошибок

``` { "code": -1, "message": "EQ/check_backup_lock: 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",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}
Примеры ошибок

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

```

eq/create_backup

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

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=create_backup" \
--data "id=VALUE"
Пример успешного ответа
{
"result": "OK",
"module": "eq",
"action": "create_backup",
"callback": "uuid-string",
"traceKey": "uuid-string"
}
Примеры ошибок

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

```

eq/create_pxe

Запрашивает создание PXE-конфигурации для последующей переустановки ОС на сервере. Возвращает callback для отслеживания процесса.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action string Идентификатор метода: create_pxe
token string Токен авторизации
id int ID сервера
root_pass string Пароль root
os_id int ID операционной системы
ssh_key string SSH ключ
post_install_script string Скрипт после установки
post_install_callback string Callback URL для завершения скрипта
hostname string Имя хоста
reinstall_key string Ключ переустановки
email string Email пользователя
os_name string Имя ОС (alias)
disk_mirror int Зеркалирование дисков
activate_windows int Активация Windows (0/1)
activation_key string Ключ активации
uefi int Режим загрузки UEFI (0/1)
attendedInstall string Аттендантная установка
root_size int Размер корневого раздела
deploy_ticket string ID тикета Kayako
ignore_duplicated_install int Игнорировать дубликаты установки
no_lvm string Отключить LVM
custom_domain string Кастомный домен
manual_choice_dsk int Ручной выбор диска

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

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

``` { "code": -1, "message": "Create PXE config request failed: error_details" }

```

eq/delete_backup

Удаляет указанный бэкап сервера. Требует выполнения асинхронной задачи.

HTTP-метод: POST

Параметры:

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

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

```

eq/deploy

Запускает процесс развертывания (деплоя) выбранного сервера или пресета. Поддерживает выбор ОС, настройку hostname, SSH-ключей и скриптов post-install.

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 Скрипт для выполнения после установки
post_install_callback string URL/метод для обратного вызова после завершения
deploy_data string Данные инвойса (WHMCS ID или email)
deploy_options string Параметры деплоя (например, тип оплаты/billing)
traffic_plan integer ID тарифного плана трафика
ipv4_amount integer Количество IPv4 адресов
custom_domain string Кастомный домен для сервера

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=deploy" \
--data "token=YOUR_TOKEN" \
--data "location=1" \
--data "os_id=5" \
--data "root_pass=StrongPassword123!" \
--data "deploy_data=INV-12345" \
--data "deploy_options=billing_type=auto"
Пример успешного ответа
{
"result": "OK",
"action": "deploy",
"callback": "7bc29eb23fb1b879b21fce509597f07c",
"ticket": "123456"
}
Примеры ошибок

``` { "code": -1, "message": "EQ/deploy: Empty billing data." }

```

eq/get_ipmi

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

HTTP-метод: POST|GET

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=get_ipmi" \
--data "id=VALUE"
Пример успешного ответа
{
"result": "OK",
"ipmi": [
{
"IP": "192.168.1.100",
"MAC": "00:1A:4C:B3:00:01",
"vendor": "Supermicro"
}
]
}
Примеры ошибок

``` { "code": -2, "message": "Authentication required" }

```

eq/get_traffic

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

HTTP-метод: POST|GET

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=get_traffic" \
--data "id=VALUE"
Пример успешного ответа
{
"result": "OK",
"module": "eq",
"action": "get_traffic",
"id": 123,
"traffic": []
}
Примеры ошибок

``` { "code": -1, "message": "\(module/\)action: invalid server id" }

```

eq/get_upgrade_key

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

HTTP-метод: POST|GET

Параметры:

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

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

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

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

```

eq/getserversforannounce

Возвращает список доступных (rent/power_off) серверов пользователя, подходящих под ограничения по маскам IPv4 (/23 и /24), которые можно использовать для анонсирования IP-адресов.

HTTP-метод: POST|GET

Параметры:

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

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

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": "1.2.3.0/23",
"mask_24": "1.2.3.0/24"
}
]
}
Примеры ошибок

``` { "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=123"
Пример успешного ответа
{
"result": "OK",
"groups": [
{
"tag": "example_group",
"value": "1"
}
]
}
Примеры ошибок

``` { "code": -2, "message": "EQ: action required" }

```

eq/hard_off

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

HTTP-метод: POST

Параметры:

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

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

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

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

```

eq/history

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

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action string Идентификатор метода: history
id int ID сервера
token string Токен авторизации
type array<string> Фильтр по типам событий
date_from string Дата начала периода (YYYY-MM-DD)
date_to string Дата конца периода (YYYY-MM-DD)

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

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

eq/list

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

HTTP-метод: GET|POST

Параметры:

Параметр Обязательный Тип Описание
action string Имя действия (list)
token string Токен авторизации
group[] string[] Группы оборудования
dc int[] ID дата-центра
location[] string[] Код локации (RU, NL и т.д.)
rack[] int[] ID стойки
status[] string[] Статус сервера (rented, prepare_full и т.д.)
owner[] string[] Владелец оборудования
component[] int[] ID аппаратных компонентов
type[] string[] Тип оборудования (server, switch и т.д.)
ip[] string[] IP адрес
mac[] string[] MAC адрес
account_id[] int[] ID аккаунта биллинга
billing[] string[] Регион биллинга (en/ru)
email[] string[] Email пользователя
id[] int[] ID оборудования
full boolean Возвращать полные данные (для админов)
kvm string Параметры KVM
serialNumber string Серийный номер

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

curl -s "https://invapi.hostkey.ru/eq.php" -X GET \
--data "action=list" \
--data "token=HOSTKEY_TOKEN" \
--data "status[]=rented" \
--data "location[]=RU"
Пример успешного ответа
{
"result": "OK",
"servers": [
{
"id": 123,
"status": "rent",
"hostname": "srv-01.hostkey.com",
"ip": [
"1.2.3.4"
],
"is_prebill": false,
"project_ids": [],
"is_owner": "Colocation"
}
]
}
Примеры ошибок

``` { "code": -2, "message": "EQ: action required" }

```

eq/off

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

HTTP-метод: POST

Параметры:

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

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

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

eq/on

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

HTTP-метод: POST

Параметры:

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

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

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

eq/order_instance

Запуск процесса развертывания нового сервера из пресета или переустановки существующего сервера с выбором ОС и дополнительного ПО.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action string Идентификатор метода: order_instance
token string Токен авторизации
id int ID существующего сервера для переустановки
preset string ID или имя пресета для заказа нового инстанса
root_pass string Пароль root (не должен содержать @ или #)
os_template string Шаблон ОС для деплоя из шаблона
soft_id int ID дополнительного программного обеспечения
os_id int ID операционной системы
ssh_key string SSH публичный ключ
post_install_script string Скрипт после установки
hostname string Имя хоста
root_size int Размер корневого раздела (GB)
email string Email для уведомлений/деплоя
deploy_period string Период оплаты (hourly, quarterly, semi-annually, annually)
ipv4_amount int Количество IPv4 адресов
custom_domain string Пользовательский домен
vlan int ID приватного VLAN
deploy_data string Данные для деплоя (для админа)
deploy_options string Опции деплоя (для админа)
traffic_plan int ID тарифного плана трафика

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=order_instance" \
--data "token=YOUR_TOKEN" \
--data "root_pass=SecurePass123!" \
--data "preset=ubuntu-docker-preset"
Пример успешного ответа
{
"result": "OK",
"action": "order_instance",
"callback": "7bc29eb23fb1b879b21fce509597f07c",
"deploy_status": "install",
"id": 123,
"os_name": "Ubuntu 22.04",
"soft_name": "Docker"
}
Примеры ошибок

``` { "code": -1, "message": "Reinstall init for server 123 failed: error message" }

```

eq/ovirt_novnc

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

HTTP-метод: POST

Параметры:

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

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

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

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

```

eq/reboot

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

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": "string"
}
Примеры ошибок

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

```

eq/reinstall

Создает ключ для начала процесса переустановки сервера и устанавливает начальную стадию (create_pxe).

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "id=12345"
Пример успешного ответа
{
"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
id integer ID сервера
token string Токен авторизации

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

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

``` { "code": -1, "message": "\(module/\)action: invalid server id" }

```

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

HTTP-метод: POST

Параметры:

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

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

```

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",
"action": "restore_backup",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}
Примеры ошибок

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

```

eq/search

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

HTTP-метод: POST|GET

Параметры:

Параметр Обязательный Тип Описание
action string Идентификатор метода: search
group[] array<string> Группы оборудования
dc[] array<int> ID дата-центра
location[] array<string> Код локации (RU, NL и т.д.)
rack[] array<int> ID стойки
status[] array<string> Статус сервера (rented, prepare_full и др.)
owner[] array<string> Владелец оборудования
component[] array<int> ID аппаратных компонентов
type[] array<string> Тип оборудования (server, switch и т.д.)
ip[] array<string> Поиск по IP-адресу
mac[] array<string> Поиск по MAC-адресу
account_id[] array<int> ID аккаунта в биллинге
billing[] array<string> Регион биллинга (en/ru)
email[] array<string> Поиск по email клиента
id[] array<int> Поиск по ID оборудования
full boolean Возвращать полные данные (для админов)
token string API-токен аутентификации

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=search" \
--data "token=HOSTKEY_TOKEN" \
--data "location[]=RU" \
--data "location[]=NL" \
--data "status[]=rented"
Пример успешного ответа
{
"result": "OK",
"servers": [
{
"id": 123,
"status": "rented",
"location": "NL",
"hostname": "srv-01.hostkey.com",
"is_prebill": true
}
]
}
Примеры ошибок

``` { "code": -2, "message": "EQ: action required" }

```

eq/sensors

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

HTTP-метод: POST

Параметры:

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

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

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

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

```

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 (true/false)

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

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

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

HTTP-метод: POST|GET

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=show" \
--data "id=123"
Пример успешного ответа
{
"result": "OK",
"server_data": {
"id": 123,
"status": "rent",
"Condition_Component": "power_on",
"owner": "ddevops@hostkey.com",
"type_billing": "Server",
"hostname": "srv-01.example.com"
},
"hardware": {
"cpu": "Intel Xeon E5-2680",
"ram": 64,
"hdd": 1000,
"components": []
},
"groups": [
{
"tag": "group_name",
"value": "val"
}
],
"location": {
"rack_id": 5,
"dc_location": 10,
"dc_name": "Amsterdam"
},
"OS": {
"id": 312,
"name": "Ubuntu 22.04 LTS",
"active": 1
},
"IP": [
{
"IP": "192.168.1.1",
"status": "active"
}
],
"interfaces": [],
"IPMI": {
"model": "Dell iDRAC",
"interfaces": []
},
"tags": [
{
"tag": "server_name",
"value": "my-server"
}
],
"reinstall": "",
"licenses": [],
"preset": null,
"commitment": ""
}
Примеры ошибок

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

```

eq/status

Возвращает текущий статус оборудования (power_off, rent, TT и др.) и связанные с ним данные

HTTP-метод: POST|GET

Параметры:

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

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

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

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

```

eq/status_check

Выполняет проверку текущего состояния оборудования (eq_status_check)

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=status_check" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"
Пример успешного ответа
{
"result": "OK",
"data": [
"string (status change message)"
]
}
Примеры ошибок

``` { "code": -1, "message": "Status request failed" }

```

eq/suspend

Запрашивает приостановку (suspend) или разблокировку (unsuspend) VPS/сервера. Если действие suspend, сервер будет заблокирован.

HTTP-метод: POST

Параметры:

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

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

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

``` { "code": -1, "message": "\(module/\)action: invalid server id" }

```

eq/traffic_add

Увеличивает лимит исходящего трафика для сервера и формирует счет на оплату в WHMCS.

HTTP-метод: POST|GET

Параметры:

Параметр Обязательный Тип Описание
action string Идентификатор метода: traffic_add
id int ID сервера
new_limit int Новый лимит трафика в ТБ
token string API-токен аутентификации

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=traffic_add" \
--data "id=VALUE" \
--data "new_limit=VALUE" \
--data "token=HOSTKEY_TOKEN"
Пример успешного ответа
{
"result": "OK",
"module": "eq",
"action": "traffic_add",
"invoice": 12345,
"status": "Unpaid"
}
Примеры ошибок

``` { "code": -1, "message": "\(module/\)action: invalid new_limit" }

```

Единый поиск серверов по запросу.

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": "Server 1",
"owner": "user@example.com",
"status": "rent",
"billing": "en",
"type": "server"
}
]
},
"limited": {
"servers": false
},
"category": "servers"
}
Примеры ошибок
{
"code": -2,
"message": "Authentication required"
}

eq/unit_reset

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

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=unit_reset" \
--data "id=VALUE"
Пример успешного ответа
{
"result": "OK",
"action": "unit_reset",
"callback": "string"
}
Примеры ошибок

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

```

eq/unsuspend

Запрос на снятие блокировки (unsuspend) с сервера. Если запрос прошел успешно, сервер будет разблокирован.

HTTP-метод: POST

Параметры:

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

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

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

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

```

eq/update_servers

Обновляет список доступных серверов, привязанных к аккаунту клиента в WHMCS, включая проверку активных услуг и пребилл-серверов.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action string Идентификатор метода: update_servers
token string Токен авторизации
show_products int Флаг отображения продуктов
load_servers_only string Фильтр: только серверы (true)

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=update_servers" \
--data "token=HOSTKEY_TOKEN" \
--data "show_products=1" \
--data "load_servers_only=true"
Пример успешного ответа
{
"result": "OK",
"servers": [
101,
102,
105
],
"billing_servers": [
{
"id": 50,
"status": "Pending"
}
],
"deploy_keys": {
"10:server_product_id": "key_abc123"
},
"prebill_pending": []
}
Примеры ошибок

``` { "code": -1, "message": "Failed to retrive servers list, billing error: ..." }

```

question_mark
Я могу вам чем-то помочь?
question_mark
ИИ Помощник ×