Документация API (интерфейс прикладного программирования) панели управления Invapi¶

В этой документации описан общий дизайн и принципы работы API, а также конкретные конечные точки. Также приведены примеры запросов к ним.

Информация

Панель управления invapi.hostkey.ru построена на основе этого API.

Запросы API¶

Запросы должны выполняться по протоколу HTTPS, чтобы гарантировать шифрование транзакций.

Для запросов необходимо использовать метод POST, если не указано иное.

Формат примеров API¶

Примеры в этой документации описаны с помощью сurl, HTTP-клиента командной строки. На компьютерах Linux и macOS обычно по умолчанию установлен curl, и он доступен для загрузки на всех популярных платформах, включая Windows.

Внимание

Необходимо различать API ключ key (имеет вид e2a0e5ce99aa0d0c-929d899n842g9cb4) и токен авторизации token (имеет вид 6a2796ff1efa2a09dbadcb50eef88e84). Для получения токена нужно воспользоваться методом auth/login.

Каждый пример разделен на несколько строк символом \, который совместим с bash. Типичный пример выглядит так:

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

curl -s "https://invapi.hostkey.ru/tags.php" -X POST \
--data "action=list" \
--data "token=$HOSTKEY_TOKEN" \
--data "id=ID сервера"

Параметр -X задает метод запроса. Для согласованности метод будет указан во всех примерах, даже если он явно не требуется для методов GET.

Примеры, для которых требуется объект JSON в теле запроса, передают требуемые данные через параметр --data.

Ответ на запросы происходит в формате JSON и в документации отформатирован для удобочитаемости.

Примечание

Чтобы использовать приведенные примеры, не подставляя каждый раз в них свой токен, вы можете добавить токен один раз в переменные окружения в вашей консоли. Например, на Linux это можно сделать с помощью команды:

HOSTKEY_TOKEN="8352afd235c901a504e1cdf595bbae0b"

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

Примечание

Обратите внимание, что все значения в этой документации являются примерами. Не полагайтесь на идентификаторы операционных систем, тарифов и т.д., используемые в примерах. Используйте ваши значения серверов/сетей/доменов для получения значений или перед созданием ресурсов. В некоторых случаях будет работать только API ключ аккаунта, а не конкретного сервера (и наоборот), поэтому при ошибках авторизации метода попробуйте переключить тип API-ключа.

amqp.php¶

Модуль управления очередями AMQP: мониторинг состояния через отправку сообщений и получение статистики количества задач.

Метод	Описание
`list`	Возвращает общеное количество задач в очереди AMQP.
`status`	Отправляет проверочное сообщение в очередь для проверки её работоспособности.

api_keys.php¶

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

Метод	Описание
`add`	Создает новый API ключ. Для клиентов доступно только при наличии активных сервисов или баланса.
`add_history`	Добавляет запись о событии в историю API ключей.
`count_owned`	Возвращает количество API ключей, принадлежащих текущему пользователю.
`delete`	Удаляет API ключ.
`edit`	Редактирует существующий API ключ (название, IP-адреса или привязку к серверу).
`history`	Возвращает историю действий с API ключами.
`list`	Возвращает список всех API ключей пользователя.
`list_for_customer`	Возвращает список всех API-ключей, принадлежащих текущему клиенту.
`list_for_server`	Возвращает список API-ключей, привязанных к конкретному серверу.
`view`	Возвращает детальную информацию о конкретном API-ключе.

auth.php¶

API module for authentication management, including 2FA verification, session handling, and SSO integration.

Метод	Описание
`2fa_check`	Проверяет введенный код двухфакторной аутентификации и возвращает данные сессии.
`2fa_resend`	Запрашивает повторную отправку кода двухфакторной аутентификации.
`billing_list`	Возвращает список доступных платежных систем (биллингов).
`email_check`	Проверяет существование пользователя по email и отправляет код верификации.
`flip_tag`	Создает или удаляет тег у пользователя.
`get_log_details`	Возвращает детализированные логи аутентификации для пользователя.
`github_init`	Инициирует процесс авторизации через GitHub.
`github_signin`	Инициирует процесс OAuth авторизации через GitHub, генерируя state и redirect URI.
`google_signin`	Валидирует Google ID Token и привязывает его к текущей сессии или аккаунту.
`info`	Возвращает данные текущей сессии (роль, права, email, серверы) на основе токена.
`ipalogin`	Выполняет аутентификацию пользователя в LDAP/FreeIPA и создает сессию.
`list_hashes`	Метод не реализован.
`login`	Авторизация клиента с использованием долгосрочного API ключа.
`logout`	Удаляет текущий токен доступа.
`register`	Метод не реализован (die).
`session_reset`	Сбрасывает все активные сессии пользователя, если предоставлен верный токен сброса.
`set_tag`	Создает или удаляет тег пользователя.
`sms_check`	Проверяет номер телефона на доступность для отправки SMS.
`sms_send`	Отправляет код верификации на номер телефона.
`sms_validate`	Проверяет введенный пользователем код верификации через Twilio.
`tg_verify`	Привязывает username Telegram к аккаунту пользователя.
`unregister`	Метод не реализован (die).
`validate`	Метод не реализован (break).
`validate_login`	Проверяет валидность логина и пароля в доступных биллинговых системах (WHMCS).
`vk_init`	Инициирует процесс авторизации через VK, возвращает данные для клиентской части.
`vk_signin`	Завершает процесс авторизации через VK, обменивая код на сессию.
`whmcslogin`	Выполняет вход в систему через учетные данные WHMCS или с помощью SSO провайдеров.

backup_journal.php¶

Модуль журнала резервного копирования: получение статистики и списков выполненных операций

Метод	Описание
`stats`	Возвращает агрегированную статистику по журналам резервного копирования.

bill.php¶

Модуль управления биллингом и инвойсами: получение списков услуг, экспорт данных клиента в CSV, управление инвойсами и просмотр истории платежей

Метод	Описание
`billing_list`	Возвращает список всех платежных записей (биллингов), привязанных к конкретному сервису.
`customer_billings_export`	Генерирует CSV-файл со всеми платежными записями текущего авторизованного клиента.
`customer_billings_list`	Возвращает список всех платежных записей текущего авторизованного клиента.
`customer_invoice_billings`	Возвращает список платежных записей, связанных с конкретным инвойсом клиента.
`customer_prebill_invoice_ids`	Возвращает список идентификаторов доступных инвойсов для текущего клиента.
`customer_services_get`	Возвращает детальную информацию о биллинговой записи, включая данные клиента и связанные серверы.
`customer_services_list`	Возвращает список биллинговых записей с поддержкой фильтрации, сортировки и пагинации.
`server_billings_list`	Возвращает список всех финансовых записей (биллингов), связанных с конкретным сервером.
`services_list`	Возвращает список всех доступных типов услуг для выбора пользователем.

customers.php¶

Модуль управления клиентами: управление списком доступа по IP, обновление данных и работа с заказами

Метод	Описание
`set_order_status`	Устанавливает статус заказа в системе WHMCS на основе ID клиента.
`update_acl`	Обновляет список разрешенных IP-адресов (ACL) для клиента. Если передать пустой список, текущий ACL будет удален.

eq.php¶

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

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

eq_callback.php¶

Обработчик обратных вызовов (callbacks) от воркеров для выполнения асинхронных задач: управление серверами, деплой, работа с ISO-образами и SNMP.

Метод	Описание
`check`	Возвращает текущий статус асинхронной задачи по её ключу (key). Может возвращать информацию о стадии выполнения или результат завершения.
`reinstall`	Принимает уведомления от воркеров о завершении или изменении статуса задач (reinstall, deploy, backup и др.) и обновляет данные в системе.

flow_hooks.php¶

Модуль управления сетевым трафиком и MAC-адресами: мониторинг потоков, защита от DDoS (blackhole/unblock), управление защитой IP и проверка соответствия MAC-адресов.

Метод	Описание
`check_traffic_flow`	Возвращает последние данные об обновлениях трафика по локациям.
`ddos_blackhole`	Инициирует процесс блокировки IP-адреса (blackhole) в случае обнаружения чрезмерного трафика. Если количество предупреждений достигло порога, выполняется сетевая блокировка.
`ddos_protect`	Активирует защиту от DDoS для указанного IP/CIDR и уведомляет клиента.
`ddos_unblock`	Снимает ограничение blackhole для конкретного IP-адреса, если у сервера был установлен соответствующий тег.
`ddos_unprotect`	Снимает защиту с IP/CIDR и удаляет соответствующие теги.
`ddos_warning`	Отправляет уведомление клиенту и логирует факт обнаружения подозрительного трафика без немедленной блокировки.
`mac_change`	Обновляет MAC-адрес для конкретного IP.
`mac_check`	Запускает процесс верификации ARP-записей: проверяет, соответствует ли текущий MAC-адрес зарегистрированному в базе для данного IP.
`mac_report`	Групповая отправка отчетов по статическим MAC-адресам для проверки соответствия IP.
`traffic_tick`	Регистрирует данные о прохождении трафика для конкретного IP-адреса или групповое обновление.

ip.php¶

Модуль управления IP-адресами: получение информации о клиенте, трафике, PTR-записях и управление основными адресами

Метод	Описание
`change_ip`	Выполняет процедуру смены текущего IPv4 адреса сервера на новый. Поддерживает предварительный просмотр доступного IP, проверку ограничений для клиентов и автоматическую блокировку старого IP в списках (RKND).
`get_client_ip`	Возвращает текущий IP-адрес клиента, совершившего запрос.
`get_ip`	Возвращает полные данные о сетевом адресе, включая маску подсети и информацию о сети.
`get_ptr`	Возвращает текущую обратную DNS-запись (PTR) для указанного IP-адреса.
`get_traffic`	Возвращает данные о входящем и исходящем трафике для IP за указанный период.
`list_free_ip`	Возвращает список неиспользуемых IP-адресов для конкретной локации на основе тегов RR.
`set_main`	Устанавливает выбранный IP-адрес как основной для сетевого интерфейса сервера.
`update_ptr`	Устанавливает новую обратную DNS-запись (PTR) для IP-адреса.
`update_ptr`	Обновляет обратную DNS-запись (PTR) для указанного IP.

iso.php¶

Модуль управления ISO-образами: загрузка, удаление, монтирование и получение списков доступных образов для серверов.

Метод	Описание
`add`	Создает новый ISO-образ или обновляет существующий с тем же именем.
`delete`	Удаляет ISO-образ из системы.
`list_iso`	Возвращает список доступных ISO-образов для пользователя или администратора.
`mount_iso`	Монтирует указанный ISO-образ к серверу.
`unmount_iso`	Размонтирует все ISO-образы с сервера.
`upload`	Загружает ISO-образ из внешнего источника по ссылке.
`uploaded`	Возвращает список ISO-образов, которые были загружены пользователем.

jenkins.php¶

Модуль интеграции с Jenkins для управления задачами автоматизации на серверах

Метод	Описание
`call`	Запускает выполнение конкретной задачи Jenkins для указанного сервера с возможностью передачи дополнительных параметров.
`get_tasks`	Возвращает список всех доступных задач Jenkins для текущего пользователя или администратора.

jira.php¶

Модуль интеграции с Jira для создания тикетов поддержки: управление питанием серверов (on/off/reboot), запуск PXE, подключение KVM и отправка запросов на техническую помощь.

Метод	Описание
`request_PXEboot`	Создает тикет в Jira для ручной загрузки сервера через PXE.
`request_assistance`	Создает тикет в Jira для получения технической или коммерческой помощи по серверу.
`request_check`	Создает тикет в Jira для проверки работоспособности и загрузки сервера.
`request_kvm`	Создает тикет в Jira для подключения IP KVM к серверу.
`request_poff`	Создает тикет в Jira для ручного выключения сервера.
`request_pon`	Создает тикет в Jira для ручного включения сервера.
`request_reboot`	Создает тикет в Jira для ручной перезагрузки сервера.

k8s.php¶

Модуль управления кластерами Kubernetes: создание, обновление, удаление, получение информации о кластере и управление токенами доступа.

Метод	Описание
`get_new_token`	Генерирует новый токен доступа для текущего пользователя на основе его email и параметров биллинга.

licenses.php¶

Модуль управления лицензиями: получение журнала транзакций и обновление дат истечения лицензий

Метод	Описание
`licenses_journal_list`	Возвращает список записей журнала лицензий с возможностью фильтрации по биллингу, типу лицензии и периоду времени.

locations.php¶

API модуль управления локациями и тегами: получение списка доступных регионов, детальная информация о локации, управление тегами и история изменений.

Метод	Описание
`add_tag`	Добавляет новый тег к локации.
`clone`	Создает копию существующей локации.
`delete_tag`	Удаляет существующий тег.
`get`	Получает детальную информацию о конкретной локации по ID или коду.
`history`	Возвращает историю изменений для локации.
`list`	Возвращает список всех доступных локаций.
`list_tags`	Возвращает список всех доступных тегов.
`show`	Возвращает детальную информацию о локации по её ID.
`update_tag`	Обновляет существующий тег локации.

net.php¶

Модуль управления сетевыми настройками: управление IP-адресами (IPv4), блокировка/разблокировка IP, получение данных о MAC-адресах и мониторинг трафика.

Метод	Описание
`add_ipv4`	Добавляет указанное количество IPv4 адресов на сервер в выбранном порту и VLAN. Если IP не указан, система подберет свободные адреса.
`block_ip`	Блокирует указанный IP-адрес через BIRD или Blackhole.
`get_acl`	Возвращает данные о правилах доступа (ACL) для порта.
`get_bandwidth`	Возвращает текущие показатели скорости (bps) для порта.
`get_bps_in`	Возвращает текущую скорость входящего трафика (Inbound bps).
`get_bps_out`	Возвращает текущую скорость исходящего трафика (Outbound bps).
`get_mac`	Возвращает информацию о MAC-адресе для указанного порта сервера.
`get_port`	Возвращает информацию о сетевом интерфейсе сервера (тип, VLAN, скорость и др.)
`get_pspeed`	Возвращает текущую скорость сетевого интерфейса
`get_snmp`	Возвращает данные SNMP из базы данных по тегу
`get_status`	Возвращает текущий статус сетевого интерфейса
`load_arp_ovirt`	Запускает процесс загрузки таблицы ARP для инженеров Ovirt
`mac_check1`	Валидация записей port_flow для конкретного ID или всех доступных
`mac_data_list`	Возвращает данные из БД и port_flow для списка предоставленных MAC-адресов
`nmap`	Запускает сетевое сканирование (NMAP) для указанного IP-адреса, принадлежащего серверу.
`port_off`	Отключает сетевой порт сервера.
`port_on`	Включает сетевой порт сервера и снимает блокировки (tags).
`remove_ipv4`	Удаляет конкретный или все IPv4 адреса с сервера.
`reset_interface_vlan`	Сбрасывает настройки VLAN сетевого интерфейса сервера до настроек по умолчанию.
`show_cacti`	Возвращает данные для построения графиков Cacti для сетевого интерфейса.
`unblock_ip`	Снимает блокировку с указанного IP-адреса.

notify.php¶

API модуль уведомлений: управление настройками, рассылка сообщений через различные каналы (Email, SMS, Telegram, Rocket) и интеграция с системами поддержки.

Метод	Описание
`get_client_notification_vips`	Возвращает список Telegram-аккаунтов (VIP) для указанных клиентов и биллинг-параметров.
`get_settings`	Возвращает текущие настройки клиента и шаблонные значения.
`save_settings`	Сохраняет настройки уведомлений для текущего клиента.
`tg_test`	Отправляет тестовое сообщение пользователю через бота.

os.php¶

Модуль управления операционными системами: управление списком ОС (добавление, удаление, обновление), поиск подходящих серверов и фильтрация доступных систем под конфигурацию сервера

Метод	Описание
`list`	Возвращает список операционных систем с учетом доступного оборудования, лицензирования и локации пользователя.
`search`	Возвращает список доступных серверов, подходящих под параметры указанной ОС.

pdns.php¶

Модуль управления DNS-записями, доменами и поддоменами: добавление, редактирование и удаление записей, доменов и поддоменов

Метод	Описание
`add_dns`	Добавляет новую DNS-запись в зону. Параметры записи передаются через массив dns.
`add_domain`	Регистрация нового домена в системе.
`add_subdomain`	Создает новый поддомен.
`delete_dns`	Удаляет существующую DNS-запись.
`delete_domain`	Удаляет домен из системы.
`delete_subdomain`	Удаляет поддомен.
`edit_subdomain`	Изменяет параметры существующего поддомена.
`get_cb_url`	Возвращает URL для отправки уведомлений (callback) системы DNS.
`get_domain_info`	Возвращает детальную информацию о конкретном домене (доступно только администраторам).
`list_domains`	Возвращает список всех доменов, принадлежащих текущему клиенту.
`list_subdomains`	Возвращает список поддоменов для текущего клиента или администратора.
`list_zones`	Возвращает список DNS-зон.
`view_zone`	Возвращает содержимое DNS-зоны.

preorders.php¶

Модуль управления предзаказами: создание, удаление, проверка статуса и уведомления клиентов

Метод	Описание
`add`	Создает новый предзаказ для клиента.
`check`	Запуск системной задачи проверки предзаказов. Метод является устаревшим (retired) и вызывается планировщиком.
`count_customer`	Возвращает количество предзаказов текущего авторизованного клиента.
`delete`	Удаляет предзаказ с учетом подтверждения отмены.
`list_customer`	Возвращает список предзаказов текущего авторизованного клиента.
`notify`	Отправляет уведомление клиенту о статусе предзаказа.

presets.php¶

Модуль управления пресетами: получение списков, поиск подходящих серверов, группировка и отображение информации о конфигурациях

Метод	Описание
`groups`	Возвращает список доступных групп пресетов
`info`	Возвращает список пресетов с указанием цен в выбранных валютах
`list`	Возвращает список всех доступных пресетов с учетом локации и прав доступа
`search`	Поиск подходящих серверов по названию пресета, области видимости и локации
`show`	Возвращает детальную информацию о конкретном пресете

rhr.php¶

Модуль управления запросами Remote Hands (RHR): создание, управление статусами, чат и история событий

Метод	Описание
`add`	Создает новый запрос на обслуживание (Remote Hands). Тип запроса может быть KVM, UNBLOCK или SERVICE.
`chat`	Добавляет видимое клиенту сообщение (историческую запись) к существующему запросу RHR.
`discard`	Рекурсивно меняет статус запроса на отмену (CANCELED или CLOSED).
`list`	Возвращает список доступных задач RHR с возможностью фильтрации по локации, статусу и дате.

rtm.php¶

Модуль управления тикетами (RTM): создание заявок, управление комментариями, поиск по ключевым словам и загрузка вложений

Метод	Описание
`add_comment`	Добавляет комментарий к существующему тикету, с возможностью прикрепления файла.
`create_credentials`	Создает персональный токен доступа (PAT) для Jira на основе предоставленных данных.
`download_file`	Загружает файл, прикрепленный к тикету.
`download_image`	Возвращает изображение из вложений тикета в формате Base64.
`get_ticket_by_id`	Возвращает детальную информацию о тикете, включая комментарии и вложения.
`get_tickets`	Возвращает список всех доступных тикетов с поддержкой фильтрации по статусу и пагинацией.
`open_ticket`	Создает новый тикет в системе (Jira) с описанием и возможным отчетом о диагностике сервера.
`search_term`	Выполняет поиск тикетов в Jira по заданному поисковому запросу с учетом прав доступа пользователя.
`search_ticket`	Возвращает полные данные по конкретному номеру (ID) тикета.

s3.php¶

Модуль управления S3 хранилищем: создание бакетов, управление аккаунтами пользователей, удаление данных и администрирование тарифов

Метод	Описание
`cancel_payment_account_deletion`	Отменяет процесс удаления сервиса и восстанавливает статус аккаунта.
`create_bucket`	Создает новый S3 бакет для указанного пользователя.
`create_order`	Создает новый S3 аккаунт и привязывает его к тарифному плану.
`delete_account`	Полное удаление S3 аккаунта и связанных с ним сервисов.
`delete_bucket`	Удаляет указанный S3 бакет.
`delete_file`	Удаляет конкретный файл из S3 бакета.
`delete_payment_account`	Инициирует процесс удаления (отмены) сервиса и подписки.
`get_available_locations`	Возвращает список всех доступных локаций, настроенных в S3 планах.
`get_buckets_rmq`	Возвращает список бакетов пользователя, информацию об использовании хранилища и данные биллинга.
`get_files`	Возвращает список файлов и папок в указанном бакете с поддержкой пагинации.
`get_users`	Возвращает список пользователей (аккаунтов) для конкретного плана или клиента.
`list_plans`	Возвращает список доступных тарифных планов с учетом налогов (VAT) и валюты пользователя.
`show_key`	Возвращает расшифрованный Access Key или Secret Key для указанного S3 аккаунта.

saas.php¶

API модуль управления SaaS-панелями: установка, перезагрузка, удаление, клонирование и получение метрик установленных приложений

Метод	Описание
`clone`	Создает клон существующего SaaS-приложения с новым именем.
`delete`	Удаляет установленную SaaS-панель и отменяет связанные услуги.
`install`	Запускает процесс установки выбранной SaaS-панели для клиента. Проверяет доступность, регион и баланс пользователя.
`install_cancel`	Отменяет процесс текущей установки приложения.
`install_restart`	Перезапускает процесс установленной SaaS-панели.
`my_app_metrics`	Получает метрики для конкретного установленного приложения.
`my_apps`	Возвращает список приложений, установленных текущим пользователем.
`upgrade`	Запускает процесс обновления установленной SaaS-панели. Требуется валидный ID панели и учетная запись.

software.php¶

Модуль управления программным обеспечением и пресетами: получение списков доступного ПО, фильтрация по параметрам сервера и отображение подходящих конфигураций (пресетов) для конкретного продукта

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

ssh_keys.php¶

API для управления SSH-ключами пользователя: добавление, обновление, удаление и просмотр списка ключей

Метод	Описание
`add`	Добавляет новый SSH-ключ в профиль пользователя
`delete`	Удаляет существующий SSH-ключ по его ID
`list`	Возвращает список всех SSH-ключей пользователя
`show`	Возвращает детальную информацию о конкретном SSH-ключе
`update`	Обновляет данные существующего SSH-ключа

stocks.php¶

Модуль управления стоковыми серверами: получение списка доступных предложений и детальная информация о конкретном сервере

Метод	Описание
`list`	Возвращает список доступных стоковых серверов с учетом локации, группы и прав пользователя.
`show`	Возвращает детальную информацию о конкретном сервере.

tags.php¶

Модуль управления тегами серверов и компонентов: добавление, удаление, поиск и очистка пользовательских и системных меток

Метод	Описание
`add`	Добавляет новый тег или обновляет существующий для сервера или списка серверов. Поддерживает массовое добавление через id_list.
`clear`	Очищает теги компонента. Клиенты очищают только не-essential теги, администраторы могут очистить всё (кроме preset).
`list`	Возвращает список всех тегов, назначенных серверу или компоненту.
`remove`	Удаляет конкретный тег с сервера. Поддерживает массовое удаление через id_list.
`search`	Ищет компоненты, соответствующие заданному тегу и значению.
`search_user`	Ищет оборудование пользователя, имеющее теги с заданным значением.
`show`	Метод не реализован (пустой)

traffic_plans.php¶

Модуль управления тарифными планами трафика: просмотр доступных планов с учетом параметров сервера или локации, добавление, удаление и обновление планов

Метод	Описание
`list`	Возвращает список тарифных планов, подходящих для конкретного сервера (по ID) или доступных в определенной локации.

twofa.php¶

Модуль управления двухфакторной аутентификацией: настройка методов (TOTP, Email, SMS, None) и верификация кодов.

Метод	Описание
`send_email_code`	Инициирует отправку одноразового кода подтверждения на указанный адрес электронной почты.
`send_sms_code`	Инициирует отправку одноразового кода подтверждения на номер телефона пользователя.
`set_method_email`	Устанавливает электронную почту в качестве основного метода двухфакторной аутентификации.
`set_method_none`	Отключает двухфакторную аутентификацию (устанавливает метод 'None').
`set_method_sms`	Устанавливает SMS-сообщения в качестве основного метода двухфакторной аутентификации.
`set_method_totp`	Устанавливает использование приложений-аутентификаторов (TOTP) в качестве основного метода 2FA.
`verify_code`	Проверяет введенный код для подтверждения личности пользователя.
`verify_email_code`	Проверяет введенный код, отправленный на электронную почту пользователя.
`verify_sms_code`	Проверяет введенный код, отправленный через SMS.
`verify_totp_code`	Проверяет одноразовый код из приложения (Google Authenticator, Authy и др.).

vm.php¶

Модуль управления виртуальными машинами: создание и управление снимками (snapshots), получение статистики загрузки CPU и настройка параметров ротации бэкапов

Метод	Описание
`cpu_graph`	Возвращает график загрузки процессора в формате base64 PNG.
`create_snapshot`	Инициирует процесс создания снимка (snapshot) виртуальной машины.
`get_snapshot`	Возвращает список доступных снимков и настроек для виртуальной машины.
`load_stats`	Запрашивает статистику (нагрузку) для виртуальной машины.
`remove_snapshot`	Инициирует процесс удаления указанного снимка.
`restore_snapshot`	Инициирует процесс восстановления виртуальной машины из существующего снимка.
`update_restore_settings`	Обновляет настройки автоматической ротации снимков и бэкапов.

whmcs.php¶

Модуль интеграции с WHMCS для управления услугами, биллингом и клиентами: отмена заказов, управление кредитами, смена тарифных планов и работа с контактами.

Метод	Описание
`add_cancel_request`	Создает запрос на отмену услуги (сервера) в системе WHMCS.
`add_contact`	Добавляет дополнительного контактного лица к клиенту.
`add_os_addon`	Добавляет лицензию операционной системы как addon к существующему серверу.
`apply_credit`	Применяет средства с баланса аккаунта к оплате конкретного инвойса.
`cancel_order`	Отменяет заказ в WHMCS, если он находится в статусе Pending/Unpaid и не содержит активных лицензий.
`change_preset`	Инициирует процесс смены конфигурационного пресета сервера.
`client_change_billing_cycle`	Позволяет клиенту самостоятельно сменить цикл оплаты (например, на более длинный).
`create_addfunds`	Создает инвойс для пополнения баланса (Add Funds) в WHMCS.
`create_product_invoice`	Создает инвойс для конкретного продукта (услуги) в WHMCS.
`delete_cancellation_request`	Удаляет существующий запрос на отмену услуги (сброс статуса ожидания).
`delete_contact`	Удаляет дополнительный контакт пользователя из WHMCS.
`generate_due_invoice`	Принудительно генерирует следующий инвойс для сервера в WHMCS.
`get_billing_data`	Возвращает подробную информацию о текущем биллинге, включая данные EU B2C и лицензии.
`get_cancellation_requests`	Возвращает список активных запросов на отмену для сервера или пользователя.
`get_client`	Возвращает подробную информацию об авторизованном клиенте, включая данные из WHMCS и внутренние теги.
`get_clients`	Возвращает список клиентов с фильтрацией по статусу.
`get_contacts`	Возвращает список дополнительных контактов для указанного клиента.
`get_emails`	Возвращает список email-адресов, связанных с клиентом.
`get_invoice`	Возвращает данные конкретного инвойса из WHMCS.
`get_invoices`	Возвращает список всех инвойсов клиента.
`get_migration_progress`	Возвращает статистику по статусам пользователей в процессе миграции.
`get_order_to_move`	Возвращает данные заказа из WHMCS, подготовленные для процесса миграции.
`get_product_invoice`	Возвращает список всех инвойсов, связанных с конкретным продуктом (сервером).
`get_products`	Возвращает список доступных продуктов для указанной группы (gid).
`get_related_invoices`	Возвращает список всех инвойсов, привязанных к аккаунту клиента.
`get_upgrade_preset_cost`	Возвращает список цен на различные конфигурации (пресеты) для улучшения сервера.
`getcredits`	Возвращает информацию о доступных средствах (кредитах) на аккаунте клиента.
`getpaymentgw`	Возвращает список доступных методов оплаты для конкретного инвойса.
`mass_pay`	Создает один общий инвойс для массовой оплаты нескольких выбранных инвойсов.
`payment_to_month_first_day`	Настраивает дату платежа сервера на первый день месяца.
`preview_client_billing_cycle_change`	Рассчитывает стоимость и детали при смене платежного цикла клиентом.
`refund_check`	Проверяет, находится ли запрос на возврат в процессе обработки (через статус тикета JIRA).
`request_cancellation`	Инициирует процесс отмены сервера и проверяет условия (наличие задолженностей, статус лицензий).
`request_refund`	Инициирует процесс возврата неиспользованных денежных средств с баланса клиента. Проверяет наличие открытых тикетов в JIRA и лимиты кредитного баланса в WHMCS.
`request_subscription_cancellation`	Запрашивает отмену автоматического продления (подписки) банковской картой.
`reset_password`	Инициирует процесс сброса пароля клиента. Если токен уже использован, позволяет установить новый пароль.
`transactions`	Возвращает список финансовых транзакций клиента.
`unpaidinvoices`	Запуск процесса обработки (напоминания) по неоплаченным инвойсам за указанный период.
`update_client`	Обновление данных профиля клиента в WHMCS и локальной базе.
`update_contact`	Обновление данных дополнительного контакта клиента.
`update_product`	Обновление параметров сервера (статус, дата продления, домен и т.д.).
`updatevat`	Обновление данных по налогу (VAT) в системе.
`verify_address`	Проверяет адрес клиента через Google Maps API для подтверждения его корректности.
`verify_email`	Проверяет корректность email-адреса и отправляет код верификации или подтверждает изменение почты.