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

eq.php

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

Методы API

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

eq/abort_reinstall

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

HTTP-метод: POST

Параметры:

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

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

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

eq/add_ipmi_admin

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

HTTP-метод: POST

Параметры:

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

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

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": "u123456",
"password": "Abc123Xyz789"
}
Примеры ошибок 
{
"code": -1,
"message": "invalid server id"
}

eq/add_ipmi_user

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

HTTP-метод: POST

Параметры:

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

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

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

eq/announceip

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

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: announceip
id ✅ int ID сервера
token ✅ string Токен авторизации
subnet ❌ string Подсеть
server ❌ string Сервер
subnetaddr ❌ string Адрес подсети
subnetaddrmask ❌ string Маска адреса подсети
asn ❌ string ASN
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 "id=VALUE" \
--data "token=HOSTKEY_TOKEN" \
--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
id ✅ int ID сервера
token ✅ string Токен авторизации

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

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

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" \
--data "token=HOSTKEY_TOKEN"
Пример успешного ответа 
{
"result": "OK",
"module": "eq",
"action": "backup_list",
"data": [
{
"id": 1,
"name": "backup_2023-10-01",
"size": 1024,
"date": "2023-10-01 12:00:00"
}
]
}
Примеры ошибок 
{
"code": -1,
"message": "invalid server id"
}

eq/backup_save_schedule

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

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: backup_save_schedule
id ✅ int ID сервера
token ✅ string Токен авторизации
backup_schedule ✅ object Объект расписания бэкапа, содержащий поля: days (массив), time (строка HH:MM), timezone (строка)

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

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

eq/boot_dev

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

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=check_backup_lock" \
--data "id=VALUE" \
--data "token=HOSTKEY_TOKEN"
Пример успешного ответа 
{
"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
id ✅ int ID сервера
token ✅ string Токен авторизации
hostname ❌ string Имя хоста

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

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

eq/create_backup

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

HTTP-метод: POST

Параметры:

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

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

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

eq/create_pxe

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

HTTP-метод: POST

Параметры:

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

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

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

eq/delete_backup

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

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=delete_backup" \
--data "id=VALUE" \
--data "token=HOSTKEY_TOKEN" \
--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 локации
root_pass ❌ string Пароль root
os_id ❌ int ID ОС
ssh_key ❌ string SSH ключ
post_install_script ❌ string Скрипт пост-установки
post_install_callback ❌ string Callback после установки
hostname ❌ string Имя хоста
reinstall_key ❌ string Ключ переустановки
deploy_data ✅ string Данные биллинга
deploy_options ✅ string Опции биллинга
deploy_price ❌ string Цена развертывания
deploy_period ❌ string Период развертывания
deploy_notify ❌ string Уведомление о развертывании
deploy_ticket ❌ string Тикет развертывания
deploy_comment ❌ string Комментарий развертывания
imitate_deploy ❌ int Имитация развертывания
imitate_error ❌ int Имитация ошибки
own_os ❌ int Своя ОС
jenkins_task ❌ string Задача Jenkins
jenkins_tests ❌ int Тесты Jenkins
traffic_plan ❌ int Трафик план
disk_mirror ❌ int Зеркалирование диска
invoice_relid ❌ int ID счета
activate_windows ❌ int Активация Windows
uefi ❌ int UEFI режим
attendedInstall ❌ int Установка с участием
root_size ❌ int Размер корня
manual_choice_dsk ❌ int Ручной выбор диска
custom_domain ❌ string Кастомный домен
ipv4_amount ❌ int Количество IPv4

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

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

eq/get_ipmi

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

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
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" \
--data "token=HOSTKEY_TOKEN"
Пример успешного ответа 
{
"result": "OK",
"ipmi": [
{
"IP": "192.168.1.1",
"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
id ✅ int ID сервера
token ✅ string Токен авторизации

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

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

eq/getserversforannounce

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

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
id ✅ int ID сервера
token ✅ string Токен авторизации

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

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

eq/hard_off

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

HTTP-метод: POST

Параметры:

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

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

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

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

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=list" \
--data "token=HOSTKEY_TOKEN"
Пример успешного ответа 
{
"result": "OK",
"servers": [
{
"id": 123,
"name": "Server 1",
"status": "rent",
"location": "NL",
"project_ids": [
1,
2
]
}
]
}
Примеры ошибок 
{
"code": -1,
"message": "invalid request"
}

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 сервера для переустановки. Если 0 или не указан — заказ нового сервера.
preset ❌ string Имя пресета для заказа нового сервера (обязательно, если id не указан).
root_pass ✅ string Пароль root. Обязателен для новых серверов и переустановок.
os_id ❌ int ID операционной системы. По умолчанию -1.
os_name ❌ string Имя ОС (алиас), если os_id не указан.
location_name ❌ string Локация сервера (например, NL, RU, US).
hostname ❌ string Имя хоста сервера.
ssh_key ❌ string SSH публичный ключ.
post_install_script ❌ string Скрипт, выполняемый после установки.
post_install_callback ❌ string URL для callback после установки.
soft_id ❌ int ID дополнительного программного обеспечения.
traffic_plan ❌ int ID тарифного плана трафика.
ipv4_amount ❌ int Количество IPv4 адресов.
deploy_period ❌ string Период биллинга (monthly, quarterly, semi-annually, annually, hourly).
promocode ❌ string Промокод для скидки.
custom_domain ❌ string Кастомный домен.
vlan ❌ string ID приватного VLAN.
ip ❌ string Приватный IP адрес.
root_size ❌ int Размер корневого раздела в ГБ.
disk_mirror ❌ int Зеркалирование диска (RAID).
no_lvm ❌ string Отключить LVM.
currency_code ❌ string Код валюты (EUR, RUB, USD).
deploy_notify ❌ int Отправлять ли уведомления о деплое.
deploy_comment ❌ string Комментарий к заказу.
deploy_ticket ❌ string ID тикета в системе поддержки.
deploy_data ❌ string Данные биллинга (email или ID инвойса).
deploy_options ❌ string Опции биллинга.
imitate_deploy ❌ int Имитация деплоя (dry run).
imitate_error ❌ int Имитация ошибки.
own_os ❌ int Использовать свою ОС.
jenkins_task ❌ string ID задачи Jenkins.
jenkins_tests ❌ int Запуск тестов Jenkins.
activate_windows ❌ int Активировать Windows.
uefi ❌ int Использовать UEFI.
attendedInstall ❌ int Интерактивная установка.
invoice_relid ❌ int RelID инвойса.
reinstall_key ❌ string Ключ для переустановки.
email ❌ string Email клиента.
cloud_init_script ❌ string Cloud-init скрипт.
os_template ❌ string Шаблон ОС.

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=order_instance" \
--data "token=HOSTKEY_TOKEN" \
--data "root_pass=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",
"total": 150.0
}
}
Примеры ошибок

``` { "code": -1, "message": "EQ/order_instance: invalid instance name", "details": { "error": "Server not found", "id": 12345 } }

```

eq/reboot

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

HTTP-метод: POST

Параметры:

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

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

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

eq/reinstall

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

HTTP-метод: POST

Параметры:

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

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

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

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

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

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

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=request_backup_link" \
--data "id=VALUE" \
--data "token=HOSTKEY_TOKEN" \
--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
id ✅ int ID сервера
token ✅ string Токен авторизации
name ✅ string Имя бэкапа

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=restore_backup" \
--data "id=VALUE" \
--data "token=HOSTKEY_TOKEN" \
--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 Дата-центр
location ❌ string Локация
rack ❌ string Рэк
status ❌ string Статус
owner ❌ string Владелец
component ❌ string Компонент
type ❌ string Тип оборудования
ip ❌ string IP адрес
mac ❌ string MAC адрес
account_id ❌ string ID аккаунта
billing ❌ string Биллинг
email ❌ string Email
name_client ❌ string Имя клиента
full ❌ int Полная информация
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": "Server 1",
"status": "rent",
"location": "NL"
}
]
}
Примеры ошибок 
{
"code": -1,
"message": "invalid request"
}

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" \
--data "token=HOSTKEY_TOKEN"
Пример успешного ответа 
{
"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

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

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=show" \
--data "id=VALUE" \
--data "token=HOSTKEY_TOKEN"
Пример успешного ответа 
{
"result": "OK",
"server_data": {
"id": 123,
"name": "Server 1",
"status": "rent",
"Condition_Component": "rent",
"cost_trafficIN": 0,
"limit_trafficIN": 0,
"cost_traffic": 0,
"new_limit_traffic": 0,
"limit_traffic": 0,
"account_id": 1,
"limit_bands": 0,
"due_date": "2023-12-31",
"IsShape": 0,
"last_backup": {
"date": "2023-10-01",
"size": 1024
},
"techAssigned": "",
"trafficPeriodOut": 0,
"trafficPeriodIn": 0,
"trafficPeriodOutBilling": 0,
"trafficPeriodInBilling": 0,
"datePeriod": "2023-10-01",
"hwconfig": "config_data",
"server_contacts": "",
"days_left": 30,
"project_ids": [
1,
2
],
"is_prebill": false,
"name_client": "Client Name"
},
"hardware": {
"components": [
{
"Type": "CPU",
"Count": 1,
"Cores": 8
}
],
"config": "config_data"
},
"groups": [
{
"id": 1,
"name": "Group 1"
}
],
"licenses": [
{
"id": 1,
"name": "License 1",
"amount": 1,
"date_buy": "2023-01-01"
}
],
"reinstall": "",
"location": {
"dc_location": "NL",
"location_id": 1
},
"OS": "Ubuntu 22.04",
"IP": [
{
"IP": "192.168.1.1",
"type": "public"
}
],
"interfaces": [
{
"id": 1,
"type": "eth0",
"mac": "00:00:00:00:00:00",
"upstream_id": 1,
"IsMain": true,
"IsVirt": false,
"Status": "up",
"switch_owner": "owner",
"switch_model": "model",
"port_of_virt_node": 0
}
],
"IPMI": {
"model": "Supermicro",
"interfaces": [
{
"IP": "192.168.1.2",
"MAC": "00:00:00:00:00:01"
}
],
"user": "admin",
"password": "password",
"white_ip": "192.168.1.3",
"ip_acl": "192.168.1.0/24",
"rule_id": 1
},
"tags": [
{
"tag": "next_duedate",
"value": "2023-12-31",
"internal": 0
}
],
"preset": "Preset Name",
"commitment": "12 months",
"preset_description": "Description of preset"
}
Примеры ошибок 
{
"code": -1,
"message": "Nothing found for id"
}

eq/status

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

HTTP-метод: POST

Параметры:

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

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

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

eq/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": "invalid server 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": "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" \
--data "token=HOSTKEY_TOKEN"
Пример успешного ответа 
{
"result": "OK",
"action": "unit_reset",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}
Примеры ошибок 
{
"code": -1,
"message": "IPMI unit reset request failed"
}

eq/unsuspend

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

HTTP-метод: POST

Параметры:

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

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

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

eq/update_servers

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

HTTP-метод: POST

Параметры:

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

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

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": [],
"deploy_keys": {}
}
Примеры ошибок 
{
"code": -1,
"message": "Failed to retrive servers list, billing error: "
}
question_mark
Я могу вам чем-то помочь?
question_mark
ИИ Помощник ×