eq.php¶

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

Методы API¶

eq/abort_reinstall¶

Прекращает процесс переустановки сервера, удаляет связанные теги (reinstall_start, autodeploy_start, autodeploy_timeout) и восстанавливает настройки VLAN.

HTTP-метод: POST

Параметры:

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
}

```

eq/add_ipmi_admin¶

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

HTTP-метод: POST

Параметры:

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": "uabc123",
"password": "secure_password_example"
}

```

eq/add_ipmi_user¶

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

HTTP-метод: POST

Параметры:

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=secret" \
--data "require_proxy_credentials=true"

{
"result": "OK",
"action": "add_ipmi_user",
"callback": "string",
"user": "string",
"password": "string"
}

```

eq/announceip¶

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

HTTP-метод: POST|GET

Параметры:

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

{
"result": "OK",
"action": "announceip"
}

```

eq/backup_get_schedule¶

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

HTTP-метод: GET

Параметры:

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

{
"result": "OK",
"action": "backup_get_schedule",
"days": [0, 0, 0, 0, 0, 0, 0],
"time": "",
"timezone": ""
}

```

eq/backup_list¶

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

HTTP-метод: POST|GET

Параметры:

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": []
}
]
}

```

eq/backup_save_schedule¶

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

HTTP-метод: POST|GET

Параметры:

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][]=1" \
--data "backup_schedule[0][days][]=3" \
--data "backup_schedule[0][time]=03:00" \
--data "backup_schedule[0][timezone]=Europe/Moscow"

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

```

eq/boot_dev¶

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

HTTP-метод: POST|GET

Параметры:

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": "string"
}

```

eq/check_backup_lock¶

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

HTTP-метод: POST

Параметры:

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

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

```

eq/check_pin¶

Проверяет PIN-код для операций.

HTTP-метод: POST

Параметры:

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 для указанного хоста. Если параметр hostname не передан, используется ID сервера.

HTTP-метод: POST

Параметры:

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

{
"result": "OK",
"callback": "string"
}

```

eq/console¶

Запрашивает запуск консоли управления сервером через IPMI/NoVNC

HTTP-метод: POST

Параметры:

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

{
"result": "OK",
"action": "console",
"callback": "string"
}

```

eq/create_backup¶

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

HTTP-метод: POST

Параметры:

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"
}

```

eq/create_pxe¶

Инициирует процесс создания конфигурации для переустановки сервера через PXE. Поддерживает настройку hostname, SSH-ключей и скриптов post-install.

HTTP-метод: POST

Параметры:

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=create_pxe" \
--data "id=VALUE" \
--data "root_pass=VALUE" \
--data "os_id=VALUE"

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

```

eq/delete_backup¶

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

HTTP-метод: POST

Параметры:

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

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

```

eq/deploy¶

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

HTTP-метод: POST

Параметры:

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=deploy" \
--data "token=YOUR_TOKEN" \
--data "location=1" \
--data "root_pass=SecurePassword123!" \
--data "deploy_data=INV-12345" \
--data "deploy_options=some_option_value"

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

```

eq/get_ipmi¶

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

HTTP-метод: GET

Параметры:

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

{
"result": "OK",
"ipmi": [
{
"IP": "192.168.1.100",
"MAC": "00:1A:4C:B0:58:E7",
"vendor": "Supermicro"
}
]
}

```

eq/get_traffic¶

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

HTTP-метод: POST|GET

Параметры:

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

{
"result": "OK",
"module": "eq",
"action": "get_traffic",
"id": 123,
"traffic": [
{
"ip": "1.2.3.4",
"volume": 50.5,
"updated": "2023-10-01",
"billed": 1,
"direction": "out"
}
]
}

```

eq/get_upgrade_key¶

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

HTTP-метод: POST|GET

Параметры:

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=get_upgrade_key" \
--data "invoice_id=VALUE"

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

```

eq/getserversforannounce¶

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

HTTP-метод: POST|GET

Параметры:

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": "255.255.254.0",
"mask_24": "255.255.255.0"
}
]
}

```

eq/groups¶

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

HTTP-метод: POST

Параметры:

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

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

```

eq/hard_off¶

Отправляет запрос на принудительное выключение (hard stop) или перезагрузку оборудования через IPMI/OpenStack.

HTTP-метод: POST

Параметры:

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

{
"result": "OK",
"action": "hard_off",
"callback": "string"
}

```

eq/history¶

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

HTTP-метод: POST

Параметры:

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¶

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

HTTP-метод: POST|GET

Параметры:

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=list" \
--data "id[]=123" \
--data "location[]=RU" \
--data "status[]=rent"

{
"result": "OK",
"servers": [
{
"id": 123,
"status": "rent",
"hostname": "server-01.hostkey.com",
"is_prebill": true,
"prebill_service_id": 456,
"prebill_rate": 10.5,
"prebill_period": "monthly",
"project_ids": [
1,
2
],
"mounted_iso": ""
}
]
}

```

eq/off¶

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

HTTP-метод: POST

Параметры:

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

Параметры:

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

Параметры:

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=order_instance" \
--data "token=HOSTKEY_TOKEN" \
--data "preset=VALUE" \
--data "root_pass=VALUE" \
--data "deploy_period=VALUE"

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

```

eq/ovirt_novnc¶

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

HTTP-метод: POST

Параметры:

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

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

```

eq/reboot¶

Отправляет запрос на перезагрузку оборудования. Если сервер находится в режиме ожидания, может потребоваться подтверждение через callback.

HTTP-метод: POST

Параметры:

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

{
"result": "OK",
"action": "reboot",
"callback": "string"
}

```

eq/reinstall¶

Запускает процесс подготовки к переустановке сервера (создание PXE-конфигурации). Возвращает ключ операции и статус этапа.

HTTP-метод: POST

Параметры:

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

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

```

eq/remove_ipmi_user¶

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

HTTP-метод: POST

Параметры:

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": "key_from_eq_del_ipmi_user"
}

```

eq/request_backup_link¶

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

HTTP-метод: POST

Параметры:

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

{
"result": "OK",
"action": "request_backup_link",
"callback": "string"
}

```

eq/restore_backup¶

Запускает процесс восстановления сервера из указанного бэкапа. Операция является асинхронной и возвращает callback для отслеживания статуса.

HTTP-метод: POST

Параметры:

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

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

```

eq/search¶

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

HTTP-метод: POST|GET

Параметры:

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "token=HOSTKEY_TOKEN" \
--data "params[group][]=1CPU" \
--data "params[group][]=2CPU" \
--data "params[status][]=rented" \
--data "params[ip][]=192.168.1.1"

{
"result": "OK",
"servers": [
{
"id": 123,
"status": "rent",
"hostname": "srv-01.hostkey.com",
"location": {
"dc_location": 1,
"rack_id": 564
},
"ip": [
{
"IP": "192.168.1.1",
"status": "active"
}
],
"is_prebill": false,
"project_ids": [],
"mounted_iso": "",
"ipmi_model": "none",
"prebill_service_id": null,
"prebill_rate": 0.0,
"prebill_rate_total": 0.0,
"prebill_period": ""
}
]
}

```

eq/sensors¶

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

HTTP-метод: POST

Параметры:

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

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

```

eq/set_pin¶

Устанавливает PIN-код для операций.

HTTP-метод: POST

Параметры:

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-метод: GET

Параметры:

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

{
"result": "OK",
"server_data": {
"id": 123,
"status": "rent",
"Condition_Component": "power_on",
"owner": "user@example.com",
"type": "Server",
"hostname": "srv-01",
"is_prebill": true,
"days_left": "",
"due_date": "",
"project_ids": [],
"prebill_service_id": 123,
"prebill_rate": 0.0,
"prebill_rate_total": 0.0,
"prebill_period": "monthly",
"name_client": "",
"last_backup": {
"date": "",
"size": ""
},
"server_contacts": "",
"sla_level": ""
},
"hardware": {
"components": [
{
"Type": "CPU",
"Count": 2,
"Cores": 8,
"model": "Intel Xeon E5-2690"
}
],
"ram": 32768,
"hdd": 1000
},
"groups": [
1,
2
],
"location": {
"rack_id": 5,
"dc_name": "Amsterdam",
"rack_position": -1,
"rack_name": "unknown",
"dc_location": -1,
"location_id": -1
},
"OS": {
"id": 10,
"name": "Ubuntu 22.04 LTS",
"active": 1
},
"IP": [
{
"IP": "192.168.1.10",
"status": "active",
"tags": []
}
],
"interfaces": [],
"IPMI": {
"model": "Dell iDRAC",
"interfaces": [],
"user": "",
"password": "",
"white_ip": "",
"ip_acl": "",
"rule_id": ""
},
"tags": [
{
"tag": "server_name",
"value": "web-srv"
}
],
"preset": null,
"commitment": "",
"licenses": [],
"reinstall": ""
}

```

eq/status¶

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

HTTP-метод: POST|GET

Параметры:

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

{
"result": "OK",
"action": "status",
"callback": "string"
}

```

eq/status_check¶

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

HTTP-метод: POST

Параметры:

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "token=abc123xyz"

{
"result": "OK",
"data": [
"User @admin changed [Hostkey RENT Server 1 (RU)]'s status `PREPARE_FAST` -> `TT` for [ticket-123] (no ticket) 5 days ago: manual change"
]
}

```

eq/suspend¶

Запрашивает приостановку (suspend) или возобновление (unsuspend) обслуживания сервера. Для выполнения операции требуется наличие прав доступа и, в некоторых случаях, проверка на блокировку администратором.

HTTP-метод: POST

Параметры:

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"
}

```

eq/traffic_add¶

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

HTTP-метод: POST

Параметры:

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

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

```

eq/unified_server_search¶

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

HTTP-метод: POST

Параметры:

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¶

Запрашивает сброс (reset) модуля IPMI для указанного сервера. Если запрос выполняется успешно, возвращается callback-ключ для отслеживания задачи.

HTTP-метод: POST

Параметры:

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

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

```

eq/unsuspend¶

Разблокирует сервер (unsuspend), если он был ранее заблокирован администратором.

HTTP-метод: POST

Параметры:

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

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

```

eq/update_servers¶

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

HTTP-метод: POST

Параметры:

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

{
"result": "OK",
"servers": [
101,
102,
105
],
"billing_servers": [],
"deploy_keys": {
"12345": "key_value_abc123"
},
"prebill_pending": []
}

```