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

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

Информация

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

Запросы API¶

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

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

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

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

Каждый пример разделен на несколько строк символом \, который совместим с 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="token"

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

Примечание

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

api_keys.php¶

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

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

auth.php¶

Модуль аутентификации и авторизации: управление сессиями, вход через WHMCS, LDAP, API-ключи и SSO (Google, GitHub, VK), верификация 2FA, SMS и email, а также управление тегами клиентов.

Метод	Описание
`2fa_check`	Валидирует код двухфакторной аутентификации для текущей сессии пользователя.
`2fa_resend`	Отправляет повторный код двухфакторной аутентификации на указанный метод (email или SMS) для текущей сессии.
`billing_list`	Возвращает список доступных платежных систем (биллингов), привязанных к текущему пользователю или доступных администратору.
`email_check`	Проверяет существование клиента по email в указанной локации биллинга. Если клиент не найден, создается новый аккаунт и отправляется код верификации на почту.
`flip_tag`	Переключает состояние тега (создает, если его нет, или удаляет, если он существует) для текущего пользователя.
`get_log`	Возвращает лог событий авторизации за указанный период или по токену.
`get_log_details`	Возвращает подробную информацию о событиях аутентификации для пользователя по его токену
`github_init`	Инициирует процесс авторизации через GitHub, генерирует уникальный state и возвращает необходимые данные для перенаправления пользователя на OAuth страницу GitHub.
`github_signin`	Инициирует процесс OAuth авторизации через GitHub, генерирует временный state и сохраняет данные для последующего обмена кодом.
`google_signin`	Выполняет вход в систему с использованием Google ID Token. Если токен валиден, привязывает аккаунт к текущей сессии или связывает существующий профиль.
`info`	Возвращает подробную информацию о текущей сессии пользователя, включая роль, права доступа (permissions), данные клиента и активные серверы.
`login`	Авторизует пользователя, используя предоставленный API-ключ. Создает сессию (hash), устанавливает токен и возвращает данные о правах доступа, серверах и параметрах биллинга.
`logout`	Очищает активный токен доступа пользователя, завершая сессию.
`session_reset`	Завершает все активные сессии пользователя, соответствующие предоставленному токену сброса и email.
`set_tag`	Создает или удаляет тег у клиента. Для обычных пользователей разрешено только управление тегом auto_credit.
`tg_verify`	Привязывает Telegram username пользователя к его аккаунту и возвращает ссылку на бота для уведомлений.
`vk_init`	Инициирует процесс OAuth-авторизации через VK, генерирует временные данные (code_challenge, state) и сохраняет их в системе для последующего подтверждения.
`vk_signin`	Инициирует процесс авторизации пользователя через социальную сеть ВКонтакте (VK OAuth2). Возвращает данные для перенаправления пользователя на страницу авторизации VK.
`whmcslogin`	Выполняет вход в систему. Поддерживает стандартную авторизацию (email/password) и SSO-методы (Google, GitHub, VK). При успешном входе возвращает токен сессии, данные пользователя и права доступа.

eq.php¶

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

Метод	Описание
`abort_reinstall`	Прерывает процесс переустановки ОС, удаляет связанные теги (reinstall_start, autodeploy_start и др.) и возвращает логи деплоя.
`add_ipmi_admin`	Создает нового пользователя с правами администратора для управления через IPMI. Если указан admin_user, создается пользователь с заданным именем.
`add_ipmi_user`	Создает нового пользователя IPMI для сервера. Если пользователь является администратором, параметры admin_user и admin_pass обязательны.
`announceip`	Выполняет процедуру анонсирования (announcement) указанной подсети для сервера. Поддерживает проверку прав доступа и работу с субсчетами.
`backup_get_schedule`	Возвращает текущее расписание резервного копирования для указанного сервера
`backup_list`	Возвращает список доступных резервных копий для указанного оборудования (сервера)
`backup_save_schedule`	Сохраняет настроенное расписание автоматических резервных копий для указанного сервера
`boot_dev`	Запрашивает запуск сервера с указанного типа носителя (PXE или диск) в режиме UEFI or Legacy.
`check_backup_lock`	Проверяет наличие активной блокировки для выполнения операций с резервными копиями сервера.
`check_pin`	Проверяет PIN-код для операций.
`clear_pxe`	Очищает конфигурацию PXE для указанного хоста. Если параметр full равен 1, удаляется всё содержимое; если 0 — только платформа остается.
`console`	Запрашивает запуск консоли управления сервером через IPMI/NoVNC
`create_backup`	Инициирует процесс создания резервной копии для указанного оборудования. Операция выполняется асинхронно.
`create_pxe`	Инициирует процесс подготовки PXE-конфигурации для установки операционной системы на сервер. Поддерживает выбор OS, настройку SSH-ключей, скриптов post-install и параметров UEFI.
`delete_backup`	Удаляет указанный бэкап сервера. Требуется имя бэкапа.
`deploy`	Инициирует процесс развертывания (деплоя) нового сервера по ID или пресету. Поддерживает выбор ОС, настройку hostname, SSH-ключей и параметров диска.
`get_ipmi`	Возвращает список доступных IPMI интерфейсов сервера, включая их IP-адреса и модель (vendor).
`get_traffic`	Возвращает данные об использовании IPv4 трафика для указанного сервера
`get_upgrade_key`	Возвращает ключ обновления (upgrade key) для сервера, привязанный к конкретному инвойсу через теги.
`getserversforannounce`	Возвращает список доступных серверов (статусов rent или power_off), подходящих под ограничения по IP-подсетям и маскам, для выполнения процедуры анонса.
`groups`	Возвращает список групп для указанного сервера
`hard_off`	Отправляет запрос на принудительное выключение (hard stop) или перезагрузку оборудования через IPMI/OpenStack.
`history`	Возвращает историю событий сервера.
`list`	Возвращает список доступных серверов и оборудования с поддержкой расширенного поиска по различным параметрам (локация, статус, тип, IP, MAC и др.)
`off`	Выключает сервер.
`on`	Включает сервер.
`order_instance`	Запуск процесса заказа нового сервера по пресету или выполнение переустановки (reinstall) существующего сервера с выбором ОС и дополнительного ПО.
`ovirt_novnc`	Запрашивает доступ к консоли oVirt noVNC для указанного сервера.
`reboot`	Отправляет запрос на перезагрузку оборудования. Если сервер находится в режиме ожидания, может потребоваться выполнение через IPMI.
`reinstall`	Запускает процесс подготовки к переустановке сервера, создает ключ задачи и уведомляет клиента.
`remove_ipmi_user`	Удаляет дополнительные учетные записи пользователей IPMI для указанного сервера.
`request_backup_link`	Запрашивает временную ссылку для скачивания резервной копии сервера.
`restore_backup`	Запускает процесс восстановления сервера из указанного бэкапа. Метод асинхронный, возвращает ключ для отслеживания задачи.
`search`	Возвращает список доступного оборудования по различным фильтрам (группа, локация, статус, тип и др.)
`sensors`	Возвращает текущие показания датчиков (температура, скорость вращения и т.д.) для указанного сервера.
`set_pin`	Устанавливает PIN-код для операций.
`show`	Возвращает подробную информацию о сервере, включая аппаратное обеспечение (hwconfig), операционную систему, IP-адреса, интерфейсы и IPMI.
`status`	Возвращает текущий статус сервера и связанные с ним данные (IP, интерфейсы, IPMI, теги)
`status_check`	Выполняет проверку текущего состояния и доступности оборудования (без привязки к конкретному ID)
`suspend`	Запрашивает приостановку (suspend) или разблокировку (unsuspend) VPS/сервера. Для выполнения операции требуется наличие прав доступа и, в некоторых случаях, проверка на блокировки администратором.
`traffic_add`	Увеличивает лимит исходящего трафика для сервера и создает соответствующий инвойс в WHMCS.
`unified_server_search`	Единый поиск серверов по запросу.
`unit_reset`	Запрос на сброс устройства (IPMI reset) для указанного сервера. Если запрос не синхронный, возвращает callback.
`unsuspend`	Запрос на снятие блокировки (unsuspend) с сервера. Если сервер был заблокирован администратором, действие выполнится немедленно.
`update_servers`	Обновляет список активных и ожидающих оплаты серверов для текущего пользователя, синхронизируя их с данными WHMCS.

eq_callback.php¶

Модуль обработки асинхронных ответов от worker-ов для управления оборудованием (EQ) и виртуальными машинами. Обрабатывает статусы задач (deploy, reinstall, backup, network), обновляет биллинг и отправ

Метод	Описание
`check`	Проверяет статус выполнения асинхронной задачи (job) по ключу. Возвращает текущее состояние, контекст и отладочную информацию.
`reinstall`	Запускает процесс переустановки операционной системы на сервере. Если в запросе указан параметр deploy_options=reinstall, выполняется полная очистка тегов и конфигурации после завершения.

ip.php¶

Модуль управления IP-адресами и сетевой инфраструктурой: получение информации об IP, управление PTR-записями, отслеживание трафика, работа с подсетями и VLAN.

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

iso.php¶

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

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

jenkins.php¶

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

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

jira.php¶

Модуль интеграции с Jira для создания тикетов поддержки по управлению серверами (питание, перезагрузка, 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 для ручной перезагрузки сервера.

nat.php¶

Модуль управления статическим NAT: добавление и удаление правил проброса IP-адресов через MikroTik.

Метод	Описание
`add_static_nat`	Создает статический NAT passthrough через Microtic для указанного сервера с поддержкой ACL и TTL.
`remove_static_nat`	Удаляет статический NAT passthrough для указанного сервера или белого IP.

net.php¶

Модуль управления сетевой инфраструктурой: добавление и удаление IP-адресов, блокировка трафика, управление состоянием сетевых портов, получение статистики и отображение графиков Cacti.

Метод	Описание
`add_ipv4`	Добавляет указанное количество IPv4 адресов на сервер в заданном порту и VLAN. Если IP не указан, система подбирает свободные адреса из доступных в данной локации.
`block_ip`	Блокирует указанный IP-адрес через BIRD или blackhole. Если параметр description не передан, используется системный префикс владельца.
`get_status`	Возвращает информацию о состоянии сетевого интерфейса (port status, speed, duplex и др.) для указанного сервера.
`port_off`	Отключает сетевой порт сервера. Если указана причина (block_reason), создается административный тег блокировки.
`port_on`	Активирует сетевой порт сервера, удаляя связанные блокирующие теги (например, 'block'), если это разрешено политикой безопасности.
`remove_ipv4`	Удаляет один или все IPv4 адреса с сервера. Если указан параметр remove_all, удаляются все привязанные адреса.
`show_cacti`	Возвращает данные для отображения графиков Cacti, связанных с сетевым интерфейсом сервера.
`show_ipv4_free`	Возвращает список доступных для назначения IPv4 адресов в указанном VLAN и с учетом тегов (tag) для конкретного сервера.
`unblock_ip`	Снимает блокировку с указанного IP-адреса на сервере через BIRD или другие механизмы управления сетью.

os.php¶

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

Метод	Описание
`list`	Возвращает список операционных систем. При указании id или instance_id фильтрует ОС по совместимости с оборудованием или пресетом. Возвращает также список исключенных ОС.

pdns.php¶

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

Метод	Описание
`add_dns`	Добавляет новую DNS-запись в указанную зону.
`add_domain`	Добавляет новый домен в систему DNS для указанного клиента.
`delete_dns`	Удаляет указанную DNS-запись.
`delete_domain`	Удаляет домен и все связанные с ним записи.
`get_cb_url`	Возвращает URL для callback-уведомлений.
`list_domains`	Возвращает список доменов клиента.
`list_zones`	Возвращает список DNS-зон для указанного клиента или сотрудника
`view_zone`	Возвращает информацию о конкретной зоне DNS для клиента или сотрудника

presets.php¶

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

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

rhr.php¶

Модуль управления заявками на удаленные работы (Remote Hands Requests): создание, фильтрация, обновление статусов и коммуникация по заявкам.

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

s3.php¶

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

Метод	Описание
`cancel_payment_account_deletion`	Отменяет процесс удаления S3-аккаунта, инициированный через запрос на удаление. Восстанавливает статус сервиса.
`create_account`	Создает новый S3 аккаунт на основе выбранного тарифного плана, проверяет лимиты бесплатных аккаунтов и кредиты пользователя, а также создает заказ в биллинговой системе.
`create_bucket`	Создает новый S3 bucket для существующего аккаунта пользователя. Требуется наличие активного s3uid, принадлежащего клиенту.
`create_order`	Создает новый S3 аккаунт (bucket) для пользователя, привязывает его к тарифному плану и оформляет заказ в биллинговой системе.
`delete_account`	Удаляет S3 аккаунт пользователя, аннулирует связанные сервисы и проводит аудит действий
`delete_bucket`	Удаляет указанный S3 bucket, предварительно проверив его принадлежность пользователю и наличие в списке доступных бакетов.
`delete_file`	Удаляет указанный файл из S3 бакета. Требуется валидный s3uid владельца аккаунта.
`delete_payment_account`	Запрашивает отмену подписки и удаление S3 аккаунта. Если действие успешно, сервис переводится в статус отмены.
`get_buckets`	Возвращает список S3 бакетов, информацию о трафике и снапшотах для указанного аккаунта
`get_buckets_rmq`	Возвращает список бакетов пользователя, информацию об использовании хранилища (usage), данные биллинга и учетные данные доступа к S3.
`get_files`	Возвращает список файлов и папок в указанном S3 бакете с поддержкой пагинации через continuation token
`get_users`	Возвращает список S3 аккаунтов с детальной информацией о тарифах, трафике и использовании хранилища. Поддерживает фильтрацию по plan_id, email, s3uid, billing и локации.
`history`	Возвращает историю действий, связанных с конкретным ID (вероятно, аккаунтом или пользователем)
`list_plans`	Возвращает список доступных S3 планов с учетом налоговой ставки (VAT) и валюты пользователя. Для администраторов может возвращать конкретный план по ID.
`show_key`	Возвращает расшифрованный секретный ключ или публичный доступный ключ S3 для указанного аккаунта

software.php¶

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

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

stocks.php¶

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

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

tags.php¶

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

Метод	Описание
`add`	Добавляет пользовательский тег к серверу или компоненту. Поддерживает массовое добавление через список ID.
`clear`	Очищает все или неэссенциальные метки от компонента. Для клиентов доступны только публичные метки.
`get`	Получает метки для компонента. (Реализация в коде пуста, метод в whitelist)
`list`	Возвращает список тегов для конкретного сервера или компонента. Для клиентов доступно ограничение по типу компонента (eq, vars).
`remove`	Удаляет тег по его имени для конкретного компонента или удаляет все указанные теги из списка ID. Если передан id_list, операция выполняется массово.
`search`	Ищет компоненты, соответствующие конкретной метке и значению.
`search_user`	Ищет оборудование пользователя по значению метки. Используется в глобальной форме поиска.
`show`	Показывает возможные метки для компонента. (Реализация в коде пуста, метод в whitelist)

traffic_plans.php¶

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

Метод	Описание
`list`	Возвращает список подходящих тарифных планов трафика для указанного сервера (id) или локации (location). Поддерживает фильтрацию по типу оборудования и конвертацию цен в EUR/USD/RUB.

vm.php¶

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

Метод	Описание
`create_snapshot`	Инициирует создание снапшота для указанной виртуальной машины. Возвращает ключ задачи для отслеживания статуса.
`get_snapshot`	Возвращает список снапшотов и настройки для указанной виртуальной машины.
`load_stats`	Инициирует загрузку статистики использования ресурсов для виртуальной машины.
`remove_snapshot`	Инициирует удаление снапшота с указанным именем.
`restore_snapshot`	Инициирует восстановление состояния виртуальной машины из снапшота.
`update_restore_settings`	Обновляет настройки автоматического восстановления и ротации снапшотов для указанной виртуальной машины.

whmcs.php¶

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

Метод	Описание
`add_contact`	Добавляет нового дополнительного контакта для клиента или создает случайного контактного пользователя.
`apply_credit`	Применяет доступный баланс (кредит) клиента для оплаты выбранного счета (invoice). Если счет после оплаты переходит в статус 'Paid', автоматически очищаются связанные теги о перерасходе трафика.
`create_addfunds`	Создает инвойс в WHMCS для пополнения баланса клиента (Add Funds). Поддерживает создание обычного инвойса или инвойса с автоматическим включением подписки.
`delete_cancellation_request`	Удаляет активный запрос на отмену услуги для конкретного сервера, позволяя восстановить статус заказа или сгенерировать новый инвойс.
`delete_contact`	Удаляет дополнительный контакт, привязанный к клиенту в WHMCS.
`download_invoice`	Возвращает PDF-файл инвойса в формате base64. Позволяет просматривать инвойс (inline) или скачивать его как файл (attachment).
`generate_due_invoice`	Генерирует следующий счет для сервера в WHMCS, учитывая текущий цикл оплаты и наличие активных аддонов.
`get_billing_data`	Возвращает детальную информацию о биллинге конкретного сервера, включая данные клиента, статус EU B2C и информацию о возвратах (если применимо).
`get_cancellation_requests`	Возвращает список активных запросов на отмену услуг для конкретного сервера или пользователя с учетом фильтрации по датам, типу и статусу оплаты.
`get_client`	Возвращает подробную информацию о клиенте из WHMCS, включая данные профиля, группы и внутренние данные системы.
`get_clientgroups`	Возвращает список доступных клиентских групп из WHMCS для указанной локации.
`get_contacts`	Возвращает список дополнительных контактов для указанного клиента или проверяет права доступа к ним.
`get_invoice`	Возвращает детальную информацию о счете из WHMCS, включая данные клиента и статус оплаты.
`get_invoices`	Возвращает список всех инвойсов, связанных с аккаунтом пользователя в WHMCS для указанной локации.
`get_related_invoices`	Возвращает список инвойсов, связанных с конкретным сервером или аккаунтом в WHMCS.
`getcredits`	Возвращает информацию о доступных кредитах на балансе аккаунта в WHMCS.
`getpaymentgw`	Возвращает список доступных методов оплаты для конкретного инвойса с обработанными ссылками на оплату.
`mass_pay`	Позволяет произвести массовую оплату нескольких инвойсов одновременно для клиента. Требуется минимум 2 инвойса.
`request_cancellation`	Инициирует процесс отмены заказа или сервиса в WHMCS. Проверяет наличие активных лицензий, статус оплаты инвойсов и возможность автоматического возврата средств (включая правила EU B2C). При наличии задолженностей по трафику может учитывать списания.
`request_subscription_cancellation`	Создает запрос в JIRA на отмену банковской подписки для сервера. Проверяет наличие активных подписок и статус оплаты.
`reset_password`	Инициирует процесс сброса пароля. Если токен не предоставлен, отправляет ссылку на email. Если токен валиден, позволяет установить новый пароль или запросить 2FA код.
`transactions`	Возвращает список финансовых транзакций пользователя из WHMCS. Если данные не найдены, возвращает пустой массив.
`update_client`	Обновляет профиль клиента в WHMCS, включая персональные данные (имя, email), контактную информацию и кастомные поля (custom fields). Поддерживает обновление юридических данных для компаний.
`update_contact`	Обновляет данные контактного лица (имя, фамилия, email, телефон) в системе WHMCS. Если обновляется email, может потребоваться повторная верификация.