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

Документация 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: мониторинг состояния через отправку сообщений и получение статистики количества задач.

Метод Описание
get Возвращает список задач из AMQP очереди с фильтрацией по статусу и пагинацией
list Возвращает общеное количество задач в очереди AMQP.
remove Удаляет задачи из очереди по указанному ID
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 Возвращает историю событий аутентификации за указанный период или по токену пользователя.
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 Метод не содержит логики (заглушка).
session_reset Сбрасывает все активные сессии пользователя, если предоставлен верный токен сброса.
set_tag Создает или удаляет тег пользователя.
sms_check Проверяет номер телефона на доступность для отправки SMS.
sms_send Отправляет код верификации на номер телефона.
sms_validate Проверяет введенный пользователем код верификации через Twilio.
tg_verify Привязывает username Telegram к аккаунту пользователя.
track_sale Отправляет данные о совершенной продаже в систему PostAffiliatePro.
unregister Метод не содержит логики (заглушка).
validate Метод не содержит логики (заглушка).
validate_login Проверяет валидность логина и пароля в доступных биллинговых системах (WHMCS).
vk_init Инициирует процесс авторизации через VK, возвращает данные для клиентской части.
vk_signin Завершает процесс авторизации через VK, обменивая код на сессию.
whmcslogin Выполняет вход в систему через учетные данные WHMCS или с помощью SSO провайдеров.

backup_journal.php

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

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

bill.php

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

Метод Описание
billing_add Создание новой записи о биллинге (платежом) вручную.
billing_del Удаляет запись о начислении (billing record) по её идентификатору. Удаление невозможно, если запись уже привязана к выставленному счету.
billing_list Возвращает список всех платежных записей (биллингов), привязанных к конкретному сервису.
customer_billings_export Генерирует CSV-файл со всеми платежными записями текущего авторизованного клиента.
customer_billings_list Возвращает список всех платежных записей текущего авторизованного клиента.
customer_invoice_billings Возвращает список платежных записей, связанных с конкретным инвойсом клиента.
customer_prebill_invoice_ids Возвращает список идентификаторов доступных инвойсов для текущего клиента.
customer_service_add Регистрация новой услуги для клиента с указанием параметров тарификации.
customer_services_del Удаляет услугу клиента. Невозможно удалить, если по ней есть активные платежные записи.
customer_services_get Возвращает детальную информацию о биллинговой записи, включая данные клиента и связанные серверы.
customer_services_list Возвращает список биллинговых записей с поддержкой фильтрации, сортировки и пагинации.
server_billings_list Возвращает список всех финансовых записей (биллингов), связанных с конкретным сервером.
server_service_data Возвращает список активных пребил-сервисов для конкретного сервера.
services_list Возвращает список всех доступных типов услуг для выбора пользователем.

bitpay.php

Интеграция сервиса Bitpay для обработки платежей и инициализации инвойсов через WHMCS.

Метод Описание
check_payment Проверяет статус платежа в Bitpay и при успешном завершении (complete) создает транзакцию в WHMCS.
init Создает инвойс Bitpay на основе данных клиента и суммы счета WHMCS, возвращая URL для оплаты.

cleanup.php

API для выполнения периодических задач по очистке данных (cleanup), включая управление IP-адресами, ISO-образами, попытками авторизации и другими системными процессами.

Метод Описание
autodeploy_timeout Запускает процесс очистки (отмены) просроченных деплоев prebill-VPS. Метод является устаревшим и переведен на выполнение через Jenkins.
check_email Отправляет тестовое письмо на системный адрес для проверки работоспособности SMTP-сервера.
check_vm Возвращает список виртуальных машин с учетом фильтрации по статусу и пагинации.
cleanup_auth_attempts Запускает процесс очистки записей о неудачных попытке входа (brute-force protection).
cleanup_ipmi Выполняет комплексную очистку: удаление неактивных IPMI IP, разблокировку BIRD (IP blocks), очистку NoVNC и ISO-монтирований.
cleanup_iso Удаляет устаревшие ISO-монтирования.
cleanup_old_ip_ranges Удаляет подсети и IPv4 диапазоны, помеченные как 'Old', если срок их действия (tag value) превышает 30 дней.
cleanup_s3_journal Очищает историю журналов в хранилище S3. Метод запускается через Jenkins.
cleanup_servers Запускает процесс очистки данных серверов, включая теги (deploy_date, autodeploy_timeout, fixed_price), обновление размера eq, очистку данных Component1, очистку RR-записей через PDNS и очистку stalled TT серверов.
cleanup_traffic Выполняет очистку периодов трафика и профилей шейпинга.
cleanup_upgrade_invoices Запускает процесс очистки инвойсов на повышение (выполняется через Jenkins). Метод является устаревшим (retired) и перенаправляет запрос в legacy-обработчик.
get_currency_rates Возвращает текущий курс обмена (RUB/EUR).
paygine_check_pending_refunds Запускает процесс проверки ожидающих возвратов через Jenkins.
preview_rates Выполняет предварительную проверку изменения цен для конкретного сервера в режиме dry-run.
reload_traffic_data Запускает процесс обновления периодов и счетчиков трафика для конкретного ID.
s3_calculate_overage Запускает процесс расчета превышений использования S3 через Jenkins.
sync_billing_status Синхронизирует данные о компонентах с внешним биллингом (WHMCS).
update_billing_currency_rates Обновляет курсы валют в системе биллинга для указанной локации.
update_components Запускает процесс обновления расположения (locations) всех компонентов.
update_currency_rates Запускает процесс обновления стоимости услуг на основе актуальных курсов EUR.
update_hw_config Запускает ежечасное обновление аппаратных конфигураций серверов.
update_jira_organizations Запускает процесс синхронизации организаций с Jira через Jenkins. Метод является устаревшим и переведен на выполнение через расписание (IAINT-2562).
update_rates Обновляет цены (sale/rent) для серверов в зависимости от выбранного этапа и локации. Поддерживает обновление конкретного сервера.
update_traffic_rates Актуализирует стоимость входящего и исходящего трафика для активных серверов клиентов.
yookassa_check_pending_refunds Запускает процесс проверки незавершенных возвратов через платежный шлюз Yookassa. Выполняется как Jenkins job.

customers.php

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

Метод Описание
bulk Выполняет массовое изменение статуса услуг (активация, приостановка, удаление) для списка серверов.
deploy_list Возвращает список событий развертывания (деплоя) по фильтрам.
deploy_load Вызывает функцию customers_deploy_load, которая добавляет теги развертывания (deploy tags) для сервера, связанного с клиентом.
deploy_logs Возвращает логи операций развертывания.
deploy_update Обновляет данные о развертывании (комментарии, периоды и т.д.).
fix_duplicates Поиск и подготовка к удалению дублирующихся записей клиентов по email в рамках одного биллинга.
get Возвращает детальную информацию о клиенте (данные из БД + WHMCS), включая расширенную группу биллинга.
list Возвращает список клиентов с примененными фильтрами.
login Генерирует временный токен доступа для входа в интерфейс клиента.
orders Возвращает список заказов, связанных с клиентом.
remove Удаляет запись о клиенте по его ID.
reset Сбрасывает данные авторизации клиента (сессии, токены и счетчик брутфорса).
reset_brute Сбрасывает счетчик ограничений (rate limiter) для клиента.
servers Возвращает список серверов, привязанных к конкретному клиенту в указанной локации.
set_order_status Устанавливает статус заказа в системе WHMCS на основе ID клиента.
update Обновляет основные данные клиента, включая billing (WHMCS), email и другие параметры профиля. При изменении email обновляются настройки 2FA.
update_acl Добавляет или удаляет список разрешенных IP-адресов (ACL) для клиента.

dashboards.php

API для управления дашбордами и отчетами в системе мониторинга.

Метод Описание
add Создает новый дашборд с заданными параметрами.
add_report Добавляет существующий отчет в указанный дашборд.
delete Удаляет существующий дашборд по его ID.
delete_report Удаляет отчет из указанного дашборда.
delete_report_all Удаляет все отчеты из указанного дашборда.
list Возвращает список всех доступных дашбордов с возможностью сортировки.
report_list Возвращает список всех отчетов, привязанных к конкретному дашборду.
show Возвращает информацию о конкретном дашборде по его ID.
update Обновляет параметры существующего дашборда (имя, публичность и список отчетов).

datacenter.php

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

Метод Описание
add Создает новую запись дата-центра с указанной локацией и параметрами.
history Возвращает историю логов для дата-центров.
list Возвращает список доступных дата-центров с фильтрацией по локации и активности.
relocate Изменяет локацию (регион) для указанного дата-центра.
remove Удаляет запись о дата-центре из базы данных.
show Получает полные данные о конкретном дата-центре по его ID.
update Обновляет атрибуты существующего дата-центра.

distributors.php

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

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

duty_ie_journal.php

API endpoint for managing the Duty IE journal entries, including adding new records, updating existing ones, and listing journal entries.

Метод Описание
add Создает новую запись в журнале Duty IE с привязкой к серверу и тикету.
list Возвращает список записей журнала с возможностью фильтрации.
update Обновляет существующую запись в журнале Duty IE.

employees.php

API endpoint for managing employee entities, including their lifecycle, history tracking, and associated server information.

Метод Описание
add Создает новую запись о сотруднике в базе данных.
add_history Добавляет новую запись в журнал истории для сущности.
history Извлекает записи логов для указанного типа и диапазона дат.
list Возвращает список сотрудников с применением фильтров.
remove Удаляет запись о сотруднике из локального кэша.
servers Возвращает список доступных опций/серверов для конкретного сотрудника.
show Возвращает данные о сотруднике по его логину.
update Обновляет данные существующего сотрудника по его логину. Принимает набор параметров для изменения профиля.

eq.php

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

Метод Описание
abort_reinstall Прерывает процесс переустановки ОС, удаляет временные теги и очищает состояние развертывания.
add_history Добавляет административную заметку в историю событий сервера. Доступно только для администраторов.
add_ipmi_user Создает нового пользователя для доступа к IPMI интерфейсу сервера.
announceip Настройка анонса IP-адресов (BGP/Announce).
appraise Рассчитывает стоимость аренды оборудования на основе списка компонентов и локации.
backup_get_schedule Возвращает текущее расписание резервного копирования для сервера.
backup_list Возвращает список доступных резервных копий сервера.
backup_save_schedule Сохраняет новое расписание резервного копирования.
boot_dev Отправляет запрос на изменение загрузочного устройства сервера (PXE или диск). Возвращает callback для отслеживания выполнения задачи.
check_backup_lock Проверяет наличие активной блокировки на выполнение операций с бэкапом для указанного сервера.
check_ip_block_disband Проверяет, доступна ли кнопка разблокировки (disband) для конкретного сервера. Возвращает статус отображения кнопки в зависимости от типа и статуса аренды.
check_pin Проверяет валидность PIN-кода для выполнения операций с оборудованием.
check_prepare_full Запускает процесс полной подготовки (deploy) серверов согласно расписание. Метод является устаревшим и переведен в режим legacy.
clean_config Очищает аппаратную конфигурацию сервера. Если full=1, удаляется всё; если 0 — только пользовательские настройки.
clear_pxe Очищает PXE-конфигурацию для конкретного хоста.
clone Клонирует существующий юнит в указанную стойку и позицию. Возможные ошибки аутентификации: Invalid token, Invalid hash.
console Запрашивает доступ к консоли сервера (NoVNC/IPMI).
create Создает новый юнит в стойке с заданным типом и размером. Доступно только администраторам.
create_backup Запускает процесс создания резервной копии для указанного сервера.
create_baremetal Отправляет запрос на создание прокси для Baremetal сервера.
create_pxe Запрашивает создание конфигурации для переустановки ОС через PXE.
delete_backup Запускает процесс удаления указанного бэкапа.
delete_baremetal Отправляет запрос на удаление прокси для Baremetal сервера.
deploy Инициирует процесс деплоя (развертывания) конкретного сервера или пресета. Поддерживает как стоковые серверы, такs и развертывание по шаблону.
download_jnlp Запрашивает загрузку JNLP файла для удаленного управления (KVM).
eq_terminate_ip_rent Завершает процесс освобождения заблокированного блока IP-адресов.
get_ipmi Возвращает IP-адрес и модель интерфейса IPMI для сервера.
get_ipmi_ip_list Возвращает список доступных IPMI интерфейсов с их IP-адресами.
get_node_gpu_counts Возвращает информацию о количестве доступных графических процессоров (GPU) на узле.
get_traffic Возвращает данные по использованию IPv4 трафика для сервера.
get_upgrade_key Возвращает ключ для выполнения операции апгрейда, привязанный к инвойсу.
getserversforannounce Возвращает список доступных серверов, подходящих под условия анонса IP-подсети.
groups Возвращает список групп, привязанных к конкретному серверу.
hard_off Отправляет команду на немедленное (жесткое) выключение сервера через IPMI.
history Возвращает список событий из журнала истории для конкретного оборудования.
hostkey_servers Возвращает список IP-адресов серверов, принадлежащих компании Hostkey.
list Возвращает список доступного оборудования с возможностью фильтрации по множеству параметров.
list_warehouses Возвращает список доступных складов (storage) с фильтрацией по локации или датацентру.
locate Возвращает данные о расположении оборудования (датацентр, стойка, слот) по ID сервера.
max_id Возвращает максимальный существующий ID из таблицы оборудования.
move_deploy Переносит процесс развертывания (деплой) с одного сервера на другой.
novnc Запрашивает доступ к консоли управления через NoVNC для указанного сервера.
off Запрос на выключение (Stop) указанного сервера.
on Запрос на включение (Start) указанного сервера.
order_instance Запуск процесса развертывания нового сервера по пресету или переустановки существующего.
ovirt_novnc Запрашивает доступ к консоли управления через oVirt NoVNC.
reboot Запрос на перезагрузку (Reboot) указанного сервера.
recreate_deploy Перезапускает процесс развертывания, используя сообщение из тега deploy_message.
recreate_novnc Перезапускает сессию NoVNC для управления сервером через браузер.
reinstall Запускает процесс переустановки сервера и создает ключ для операции.
relocate Перемещает юнит (оборудование) в другую стойку или на другую позицию.
remove_ipmi_user Удаляет дополнительные учетные записи пользователей IPMI для сервера.
rename_server Изменяет имя (hostname) существующего сервера или сбрасывает его на текущее значение из конфигурации оборудования.
replace_server Выполняет процедуру замены одного оборудования на другое с переносом настроек.
request_backup_link Запрашивает временную ссылку для скачивания резервной копии.
request_japl Отправляет запрос на генерацию и отправку JNLP-файла для удаленного управления (KVM).
request_japl Запрашивает файл для подключения к консоли KVM через Java Web Start.
restart_deploy Перезапускает процесс развертывания сервера, используя данные из тега deploy_message.
restore_backup Запускает процесс восстановления сервера из выбранной резервной копии.
run_scheduled_backups Запускает процесс выполнения всех запланированных задач резервного копирования.
search Поиск доступного оборудования по различным критериям (локация, тип, статус и т.д.).
sensors Возвращает данные датчиков (температура, обороты и т.д.) для сервера.
set_node_params Устанавливает произвольные параметры конфигурации для конкретного оборудования через JSON.
set_pin Устанавливает новый PIN-код для доступа к управлению сервером.
show Возвращает полные данные о сервере, включая конфигурацию оборудования, IP-адреса и теги.
start_speedtest Инициирует запуск теста скорости (Speedtest) на сервере с использованием специализированного образа ОС.
status Возвращает текущий статус сервера и ключ для callback.
status_check Возвращает общую информацию о состоянии системы.
stop_novnc Завершает текущую сессию NoVNC для сервера.
suspend Приостанавливает работу сервера (для VPS).
suspend Запрашивает блокировку (suspension) VPS/сервера.
sync_speedtest_tags Синхронизирует теги, связанные со спидтестом для конкретного сервера.
traffic_add Запрашивает увеличение лимита исходящего трафика и создает инвойс.
type Возвращает список доступных типов оборудования.
unified_server_search Выполняет поиск оборудования по различным критериям (ID, имя, статус и т.д.).
unit_reset Запрашивает сброс устройства (IPMI reset) для указанного сервера.
unsuspend Запрашивает разблокировку (unsuspension) VPS/сервера.
update_config Обновляет аппаратную конфигурацию сервера. Доступно только администраторам.
update_groups Обновляет список групп, к которым привязан сервер.
update_server_options Обновляет различные опции в таблице Component1 для указанного оборудования.
update_servers Обновляет список активных серверов для текущего токена/аккаунта.
validate Принимает данные от аппаратного чекера и выполняет валидацию.

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-адреса или групповое обновление.

foreman.php

Интерфейс взаимодействия с системой Foreman для получения данных об операционных системах, дисковых схемах, медиа-ресурсах, группах хостов и сетевых настройках.

Метод Описание
get_hostgroup Возвращает список доступных групп хостов для локации сервера.
get_media Возвращает доступные установочные носители (ISO/Network) для выбранной ОС.
get_network Возвращает параметры сети (gateway, mask, network) для указанного IP-адреса.
get_os Возвращает список доступных операционных систем для указанной локации с учетом прав доступа пользователя.
get_ptable Возвращает подходящие схемы разбиения разделов для конкретной ОС.

geoip.php

Модуль управления GeoIP данными: импорт сетей и метаданных стран, разрешение IP-адресов и экспорт конфигурации прокси с языковыми тегами

Метод Описание
import_country Импорт метаданных стран и континентов из GeoLite2 CSV. Перезаписывает таблицу geoip_locations.
import_networks Импорт диапазонов IPv4/IPv6 из CSV-файлов GeoLite2. Очищает существующие таблицы перед загрузкой.
proxy_config Экспорт IPv4 CIDR диапазонов с языковыми тегами (plain text output).
resolve Преобразование публичного IPv4/IPv6 адреса в данные о местоположении (geoname_id, locale_code и др.).

hardware.php

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

Метод Описание
add Создает новый аппаратный компонент в системе.
add_barcodes Добавляет новые записи штрих-кодов для сущностей.
clone Создает клон компонента на основе существующего ID.
delete_barcodes Удаляет запись штрих-кода по его ID.
eval_hw Обновляет стоимость (cost_buy) и тег ru_cost для списка аппаратных компонентов.
history Возвращает историю изменений (логи) для указанных компонентов.
list Возвращает список доступных аппаратных компонентов с фильтрацией по типу.
list_barcodes Возвращает список всех зарегистрированных штрих-кодов с применением фильтров.
list_storage Возвращает список доступных компонентов на складе с учетом фильтров по типу и локации.
merge Объединяет несколько компонентов в один (мастер-элемент).
racks_report Генерирует отчет по стоимости и конфигурации серверов внутри стоек дата-центра.
remove Удаляет компонент из базы данных по его ID.
search Поиск серверов, содержащих компоненты с определенными характеристиками.
show Возвращает детальную информацию о конкретном аппаратном компоненте.
show_barcodes Возвращает данные штрих-кода по его идентификатору.
update Обновляет данные аппаратного компонента.
update_barcodes Обновляет данные записи штрих-кода.

health.php

Модуль проверки состояния внешних сервисов: проверка доступности API Bytehand

Метод Описание
bytehand Проверяет доступность API-сервиса Bytehand через выполнение HTTP-запроса.

history.php

Модуль истории событий: получение списка записей истории с фильтрацией по типу сущности и дате

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

ip.php

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

Метод Описание
add_dhcp_lease Добавление или удаление записи в DHCP-аренде для указанного IP.
bill_traffic Запускает процесс расчета входящего и исходящего трафика для IP-адресов за указанную дату.
change_ip Выполняет процедуру смены текущего IPv4 адреса сервера на новый. Поддерживает предварительный просмотр доступного IP, проверку ограничений для клиентов и автоматическую блокировку старого IP в списках (RKND).
dhcp_report Получение отчета по DHCP-арендам в указанной локации.
flow_remove Удаляет запись о сетевом потоке (mac_flow) по её ID.
get_client_ip Возвращает текущий IP-адрес клиента, совершившего запрос.
get_ip Возвращает полные данные о сетевом адресе, включая маску подсети и информацию о сети.
get_ip_pricing Возвращает таблицу цен на IPv4 адреса для различных конфигураций.
get_ptr Возвращает текущую обратную DNS-запись (PTR) для указанного IP-адреса.
get_range_ip Возвращает данные о диапазоне IP-адресов вместе с информацией о серверах.
get_range_subnets Возвращает список подсетей, входящих в указанный IPv4 диапазон.
get_subnet Возвращает данные о подсети (network, broadcast, netmask и др.) по её IP-адресу или идентификатору.
get_traffic Возвращает данные о входящем и исходящем трафике для IP за указанный период.
get_vlan Возвращает список VLAN для указанной локации.
get_vlan_ip Возвращает полный список IP-адресов, принадлежащих конкретному VLAN.
ip_flow Загружает данные о MAC-адресах (flow) для указанного IP.
ip_history Возвращает историю изменений для конкретного IP-адреса.
list_free_ip Возвращает список неиспользуемых IP-адресов для конкретной локации на основе тегов RR.
list_private_vlans Возвращает список приватных VLAN для указанного email.
list_range_ip Возвращает список IPv4 диапазонов (subnets) с привязанными тегами для указанной локации или всех локаций.
list_subnets Возвращает список всех доступных IPv4 подсетей для указанной локации.
list_subnets_with_tags Возвращает список подсетей в указанной локации с учетом фильтрации по VLAN.
list_used_ip Возвращает список всех занятых IPv4 адресов в указанной локации.
list_white_ip Возвращает список IPv4 адресов, находящихся в белом списке (whitelist) для указанной локации.
range_add_subnet Добавляет новую подсеть в существующий IP-диапазон через вызов функции range_add_subnet.
range_clear_subnet Очищает подсеть от привязанных IP-адресов (удаляет серверные привязки).
range_delete_subnet Удаляет указанную подсеть из диапазона.
range_show_subnet Возвращает информацию о конкретной подсети в рамках диапазона по её идентификатору.
range_update_subnet Обновляет данные существующей подсети (VLAN, описание, локация).
relocate_ip Перемещает указанные IP-адреса с одного сетевого интерфейса (NIC) на другой.
remove_dhcp_lease Удаляет запись о DHCP-аренде для указанного IP-адреса.
set_main Устанавливает выбранный IP-адрес как основной для сетевого интерфейса сервера.
set_white_ddos Добавляет или удаляет IP-адрес из белого списка защиты от DDoS для конкретного сервера.
update_ptr Устанавливает новую обратную DNS-запись (PTR) для IP-адреса.
update_ptr Обновляет обратную DNS-запись (PTR) для указанного IP.
update_range_ip Обновляет параметры IPv4 диапазона (скрытость, группы).
update_subnet Обновляет данные существующей подсети.
update_vlan Обновляет описание (description) для указанного VLAN. Если параметр full передан, возвращает полные данные о VLAN.

ipmip.php

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

Метод Описание
add Создает новую запись IP-адреса в системе.
delete Удаляет существующую запись IP-адреса по её ID.
list Возвращает список IP-адресов, отфильтрованных по локации.
show Возвращает детальную информацию о конкретной записи IP-адреса.

ipv4rs.php

API модуль управления IPv4 ресурсами: добавление, обновление, удаление и просмотр записей в базе данных

Метод Описание
add Создает новую запись IPv4 ресурса, привязанную к владельцу (email администратора).
delete Удаляет запись IPv4 ресурса по её ID.
list Возвращает список всех запи项 IPv4 ресурсов.
show Возвращает детальную информацию о конкретной записи IPv4 ресурса по её ID.
update Обновляет существующую запись IPv4 ресурса по её ID.

iso.php

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

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

jenkins.php

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

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

jenkins_journal.php

(описание будет добавлено при генерации)

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

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 для ручной перезагрузки сервера.

journal.php

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

Метод Описание
delete Удаляет запись из операционного журнала по идентификатору.
list Возвращает список событий операционного журнала с поддержкой расширенной фильтрации и пагинации.

k8s.php

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

Метод Описание
admin_delete_cluster Удаляет кластер по его идентификатору. Доступно только в административном режиме.
check_user_token Проверяет доступ пользователя к конкретному кластеру.
create_cluster Инициирует процесс создания нового Kubernetes кластера.
delete_cluster Удаляет существующий Kubernetes кластер.
get_cluster Возвращает детальную информацию о кластере.
get_cluster_auth_token Проверяет доступ и возвращает данные кластера на основе предоставленного токена.
get_log Возвращает список выполненных или текущих задач (логов) для кластеров.
get_new_token Генерирует новый токен доступа для текущего пользователя на основе его email и параметров биллинга.
list Возвращает список доступных кластеров с учетом прав доступа пользователя.
update_cluster Обновляет конфигурацию существующего кластера Kubernetes.

leasing_contracts.php

(описание будет добавлено при генерации)

Метод Описание
create Создает новый договор лизинга.
delete Удаляет договор лизинга и снимает привязку со всех серверов.
get Возвращает детальную информацию о конкретном договоре лизинга.
list Возвращает список всех договоров лизинга с возможностью фильтрации по компании.
show_servers Возвращает список ID серверов, привязанных к договору.
update Обновляет данные существующего договора лизинга и перепривязывает серверы к компании.
update_server_list Заменяет текущий список серверов в договоре на новый.

licenses.php

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

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

livechat.php

Модуль интеграции LiveChat: управление историей чатов, сохранение данных диалогов и получение списков сообщений

Метод Описание
delete_chat Удаляет запись о чате из базы данных по его идентификатору.
get_chats Получает расширенную историю чатов с данными о посетителях и сообщениях через внешний API.
load_chats Загружает список чатов по фильтрам даты и категории.
save_chat Создает новую запись о завершенном чате в базе данных.
update_chat Обновляет конкретное поле в записи чата.

locations.php

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

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

migrate.php

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

Метод Описание
accept_migration_invapi Принимает приглашение на миграцию через API.
cancel_migration Отменяет текущий процесс миграции.
check_hosting_to_move Проверяет возможность переноса хостинга и рассчитывает конвертацию валют.
check_part_of_list Проверяет наличие элементов в списке миграции.
contacts Получение данных контактов.
convert_price Конвертирует сумму из одной валюты в другую.
customer Получение информации о клиенте.
customer_suggest_list Возвращает список подсказок (предложений) клиентов на основе поискового запроса.
get_csv Возвращает данные в формате CSV для скачивания.
get_customers Возвращает список клиентов с поддержкой пагинации и фильтрации по локации.
get_customers_by_email_list Возвращает список клиентов на основе предоставленного списка Email-адресов.
get_hosting_to_move Возвращает данные о доступных хостингах (серверах) для миграции в указанной локации.
get_hostings_list Возвращает список хостингов, доступных для миграции в рамках указанной локации.
get_inactive_customers Возвращает список неактивных клиентов с фильтрацией по датам, типам и статусам сервисов.
get_migrated_customers Возвращает список клиентов, прошедших процедуру миграции за указанный период.
get_order_to_move Возвращает детальную информацию о заказе, доступном для миграции.
get_part_of_list Возвращает фрагмент (страницу) списка клиентов с учетом пагинации.
hosting Выполняет миграцию параметров хостинга.
migrate_inactive_list Запускает процесс миграции неактивных клиентов.
number_customer_lists Сравнивает количество записей в двух биллинговых локациях.
put_hosting_to_move Завершает процесс миграции хостинга, обновляет данные в биллинге и логирует изменения.
rollback_inactive_list Выполняет откат изменений для списка неактивных клиентов. Поддерживает режим пробного запуска (dry run).

nat.php

Модуль управления NAT: добавление и удаление статических правил, управление IP-адресами в режиме passthrough через Microtic

Метод Описание
add_nat_ip Добавляет IP-адрес в список статического NAT проброса через MikroTik.
add_static_nat Добавляет статический NAT (passthrough) через MikroTik.
clear_static_nat Удаляет застрявшие правила статического NAT через внутренний IP.
drop_nat Удаляет запись о NAT из базы данных.
get_static_nat Получает активные правила статического NAT проброса из MikroTik.
list_nat_ip Возвращает список всех IP-адресов из статического NAT проброса.
release_nat_ip Освобождает IP-адрес из статического NAT проброса через MikroTik.
remove_static_nat Удаляет статический NAT passthrough через Microtic. Требуется проверка прав доступа для клиента.

net.php

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

Метод Описание
add_ipv4 Добавляет указанное количество IPv4 адресов на сервер в выбранном порту и VLAN. Если IP не указан, система подберет свободные адреса.
add_port Добавляет или обновляет данные сетевого интерфейса (NIC) для сервера.
blackhole_ip Блокирует указанный IP-адрес с использованием режима blackhole в BIRD. Если включена опция 4-х часов, устанавливается временная метка истечения блокировки.
block_ip Блокирует указанный IP-адрес через BIRD или Blackhole.
clear_acl Очищает правила доступа (ACL) на порту сервера.
del_port Удаляет сетевой интерфейс (порт) с сервера.
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 Возвращает текущий статус сетевого интерфейса
get_switch Возвращает список портов и их состояние для указанного коммутатора.
get_switch_all Возвращает данные о портах и состоянии коммутатора по его ID.
get_vlan Возвращает информацию о текущем VLAN для порта или интерфейса.
list_10g_ips Возвращает список IP-адресов, подключенных к интерфейсам со скоростью 10G.
list_blocked_ip Возвращает список всех IP-адресов, находящихся в черном списке.
list_switches Возвращает список доступных коммутаторов для указанной локации или сервера.
list_vps_ips Возвращает список IP-адресов, используемых в виртуальных машинах (VPS).
load_arp Запускает процесс загрузки ARP-таблицы из роутера для указанного IP или локации.
load_arp_ovirt Запускает процесс загрузки таблицы ARP для инженеров Ovirt
load_mac_list Загружает список MAC-адресов для указанной локации.
load_snmp Запускает задачу Jenkins для сбора SNMP данных по всем или части устройств.
load_switch Возвращает данные о MAC/IP и портах физического коммутатора. Если ID не указан, возвращает список всех доступных коммутаторов.
mac_check Валидация записей port_flow по конкретному ID или массовая проверка всех записей с фильтрацией.
mac_check1 Валидация записей port_flow для конкретного ID или всех доступных
mac_data Возвращает информацию о серверах, привязанных к конкретному MAC-адресу, и историю flow.
mac_data_list Возвращает данные из БД и port_flow для списка предоставленных MAC-адресов
mac_refresh Запуск процесса сканирования всех сетей для обновления таблиц MAC и ARP через nmap.
mount_nic Монтирует сетевой интерфейс (NIC) на сервер через указанный коммутатор и порт.
nmap Запускает сетевое сканирование (NMAP) для указанного IP-адреса, принадлежащего серверу.
port_flow Возвращает таблицу потоков портов (port flow) с применением фильтров.
port_of_virt_node Добавляет или удаляет тег 'port_of_virt_node' для указанного сервера.
port_off Отключает сетевой порт сервера.
port_on Включает сетевой порт сервера и снимает блокировки (tags).
port_reset Сбрасывает конфигурацию сетевого порта сервера (VLAN, скорость и др.) на значения по умолчанию.
relocate_nics Переносит все сетевые интерфейсы с одного сервера на другой.
remove_ipv4 Удаляет конкретный или все IPv4 адреса с сервера.
remove_selected_ipv4 Удаляет список указанных IPv4 адресов с сервера.
remove_shape_port Удаляет ограничения полосы пропускания (shaping) с сетевого порта.
reset_interface_vlan Сбрасывает настройки VLAN сетевого интерфейса сервера до настроек по умолчанию.
set_acl Устанавливает списки контроля доступа (ACL) для сетевого порта.
set_bandwidth Устанавливает ограничение полосы пропускания (bandwidth) для сетевого интерфейса.
set_nic_type Устанавливает тип сетевого адаптера (NIC) для порта сервера.
set_port Настройка параметров сетевого порта (скорость, VLAN, безопасность и др.) на сервере.
set_port_security Управление ограничением MAC-адресов на порту.
set_vlan Установка или изменение VLAN для порта сервера.
shape_net Настройка ограничения трафика (shaping) для сети.
shape_port Настройка ограничения трафика для конкретного порта.
show_cacti Возвращает данные для построения графиков Cacti для сетевого интерфейса.
show_ipv4_free Возвращает список доступных IPv4 адресов для сервера в указанном VLAN.
sync_cacti Синхронизирует данные порта с системой мониторинга Cacti.
unblock_ip Снимает блокировку с указанного IP-адреса.
unmount_nic Выполняет размонтирование (unmount) сетевого интерфейса сервера с портом коммутатора.

notify.php

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

Метод Описание
call Инициирует голосовой вызов на указанный номер телефона с проигрыванием заданного кода.
get_client_notification_vips Возвращает список Telegram-аккаунтов (VIP) для указанных клиентов и биллинг-параметров.
get_settings Возвращает текущие настройки клиента и шаблонные значения.
jira Создает новый тикет в системе Jira через соответствующую очередь.
kayako Создает тикет в системе поддержки Kayako.
kayko_note Добавляет внутреннюю заметку к существующему тикету Kayako.
mail Отправляет электронное письмо через SMTP (Yandex или Google).
rocket Отправляет сообщение в канал Rocket.Chat.
save_settings Сохраняет настройки уведомлений для текущего клиента.
send_bug_report Формирует и отправляет отчет об ошибке в Rocket.Chat с указанием автора.
send_client_notification_rocket Отправляет массовое уведомление через Rocket клиентам, привязанным к списку указанных Jira-тикетов. Также оповещает VIP-клиентов в Telegram.
sms Отправляет текстовое сообщение на указанный номер телефона через доступный шлюз.
tg_test Отправляет тестовое сообщение пользователю через бота.

options.php

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

Метод Описание
bind Привязывает выбранную опцию (например, лицензию) к серверу по его ID или IP-адресу.
get Возвращает данные конкретной опции по её ID.
history Возвращает историю действий (логи) для указанной опции или компонента.
list Возвращает список всех доступных опций или лицензий для конкретного сервера/IP.
logs Возвращает логи для программного обеспечения (software). Доступно только для опции 'software'.
remove Удаляет существующую опцию по её ID.
servers Возвращает список серверов, связанных с указанной опцией.
update Создает новую или обновляет существующую конфигурацию (опцию). Если указан id, происходит обновление текущей записи.

os.php

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

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

paygine.php

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

Метод Описание
check Проверяет текущий статус заказа и завершает транзакцию, если платеж подтвержден.
init Инициализирует новый заказ на оплату счета или возобновляет существующий активный заказ.
sbp_check Проверяет статус привязки счета СБП по идентификатору QR-кода.
sbp_subscribe Инициализирует процесс привязки счета СБП для автоматических платежей.
sync_orders Синхронизирует заказы по указанным биллингам за определенный период времени. Доступно только администраторам.

paypal.php

(описание будет добавлено при генерации)

Метод Описание
charge_vault Выполняет списание платежа по сохраненному токену (Vault) для указанной инвойса.
check_order Проверяет статус захвата (capture) PayPal заказа и завершает процесс оплаты.
check_payment Создает подписку или проверяет доступность оплаты для клиента.
check_subscription Проверяет наличие недавних транзакций по подписке и подтверждает её.
create_order Создает заказ PayPal (обычный или с использованием Vault).
create_payment_token Создает токен для привязки карты (Vault) к аккаунту.
create_setup_token Инициирует процесс создания Setup Token в PayPal для последующего сохранения карты.
create_subscription Инициирует процесс создания PayPal-подписки для клиента на основе существующего счета (invoice).
revoke_vault Удаляет сохраненный способ оплаты (PayPal Vault) из профиля клиента.

pdns.php

API для управления DNS-записями, доменами и поддоменами в системе PowerDNS.

Метод Описание
add_dns HTTP-метод: POST
add_domain Регистрирует новый домен в системе.
add_subdomain HTTP-метод: POST
delete_dns Удаляет существующую DNS-запись.
delete_domain Удаляет домен из системы.
delete_subdomain Удаляет поддомен.
edit_subdomain HTTP-метод: POST
get_cb_url Возвращает URL для вызова callback-функции.
list_domains HTTP-метод: POST
list_subdomains HTTP-метод: POST
list_zones HTTP-метод: POST
view_zone Возвращает информацию о DNS-зоне, включая её локацию и имя.

pdu.php

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

Метод Описание
bind Метод не реализован (пустой кейс).
check_overload Запуск процесса проверки PDU на наличие перегрузок (выполняется по расписанию). Метод помечен как устаревший.
get Возвращает список доступных SNMP-тегов потребления энергии для конкретного PDU и данные по графикам (total, 5min, 2h, 24h).
load_version Запрашивает текущую версию прошивки устройства через SNMP.

permissions.php

(описание будет добавлено при генерации)

Метод Описание
add Назначает указанные функции ролям или наоборот. Поддерживает пакетное назначение через массивы.
delete Удаляет связь между ролью и функцией.
func_add Создает новую функцию в системе.
func_delete Удаляет функцию из системы.
func_list Возвращает список всех доступных функций.
func_show Возвращает детальную информацию о конкретной функции.
func_update Обновляет параметры существующей функции.
list Возвращает список разрешений (связок ролей и функций) с возможностью фильтрации по конкретной роли или функции.
role_add Создает новую роль с заданным именем.
role_delete Удаляет существующую роль.
role_list Возвращает список всех доступных ролей.
role_show Возвращает детальную информацию о конкретной роли.
role_update Обновляет параметры существующей роли.

preorders.php

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

Метод Описание
add Создает новый предзаказ для клиента.
check Запуск системной задачи проверки предзаказов. Метод является устаревшим (retired) и вызывается планировщиком.
count_admin Возвращает общее количество предзаказов в системе для администратора.
count_customer Возвращает количество предзаказов текущего авторизованного клиента.
delete Удаляет предзаказ с учетом подтверждения отмены.
description Возвращает текстовое описание для конкретного предзаказа.
email Инициирует отправку электронного письма по предзаказу.
list_admin Возвращает полный список всех предзаказов системы для администратора.
list_customer Возвращает список предзаказов текущего авторизованного клиента.
notify Отправляет уведомление клиенту о статусе предзаказа.
notify_confirm Подтверждает получение или прочтение уведомления по предзаказу.
validate_cancel_token Проверяет валидность специального токена для отмены предзаказа.
view Возвращает детальную информацию о конкретном предзаказе.

presets.php

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

Метод Описание
add Создает новый кастомный пресет с заданными характеристиками оборудования и ценой.
clone Создает дубликат существующего пресета с новым именем.
groups Возвращает список групп пресетов.
history Возвращает историю действий, связанных с пресетами за указанный период или по типу.
info Возвращает список пресетов с указанием цен в выбранных валютах.
list Возвращает список доступных пресетов с учетом локации и прав доступа.
remove Удаляет пресет и связанные с ним теги.
search Возвращает список серверов, подходящих под параметры указанного пресета.
show Возвращает детальную информацию о конкретном пресете.
show_suitable Возвращает список серверов, которые подходят под параметры указанного пресета.
speed_test_locations_get Запрашивает список доступных локаций для проведения теста скорости.
update Обновляет параметры существующего пресета.

projects.php

(описание будет добавлено при генерации)

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

rack.php

Модуль управления стойками (rack): создание, удаление, перемещение между дата-центрами, обновление атрибутов и просмотр истории изменений.

Метод Описание
add Создает новую стойку в указанном дата-центре.
history Возвращает историю событий для конкретной стойки или всех стоек за период.
list Возвращает список доступных стоек в дата-центре.
relocate Перемещает стойку в другой дата-центр.
remove Удаляет стойку из системы.
show Возвращает детальную информацию о стойке по её ID.
update Обновляет параметры существующей стойки.
update-order Обновляет порядок расположения стоек в дата-центре на основе переданного массива данных.

report_groups.php

(описание будет добавлено при генерации)

Метод Описание
add Создает новую группу отчетов с указанным именем.
delete Удаляет группу отчетов по её идентификатору.
groups_list Возвращает список групп отчетов для указанного идентификатора.
list Возвращает список всех доступных групп отчетов.
reports_add Добавляет указанные отчеты в существующую группу.
reports_add_group Добавляет отчет в группу (через связь групп).
reports_delete Удаляет указанные отчеты из группы.
reports_delete_group Удаляет связь между группой и конкретным отчетом.
reports_list Возвращает список всех отчетов, входящих в указанную группу.
show Возвращает детальную информацию о конкретной группе отчетов.
update Обновляет название существующей группы отчетов.

reports.php

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

Метод Описание
abusedb Запускает процесс сканирования IP-адресов на предмет вредоносной активности (DDoS, Spam, Brute-Force и др.) с использованием внешнего API.
active_delays Возвращает отчет по текущим задержкам (delays) в процессах деплоя, включая количество реинсталляций и лимиты.
active_services Возвращает список активных сервисов с данными о выручке. Поддерживает экспорт в CSV.
add Добавляет новую запись в систему отчетов через передачу массива параметров.
add_conversions Добавляет данные о конверсиях в систему отчетов.
asa_log Сохраняет логи событий автоматической безопасности в журнал.
billing_cycle_journal Возвращает список изменений в циклах оплаты (billing cycles) клиентов.
billing_cycle_journal_migrate Запускает процесс миграции старых данных журналов биллинга.
billing_sync Запускает процесс синхронизации данных из WHMCS с локальной базой данных. Метод помечен как устаревший (Retired).
bm_ip Возвращает список IP-адресов для Bare Metal серверов в указанной локации.
clone Создает копию существующего объекта (пресета или отчета).
count_software_installs Метод помечен как Retired. Работа перенесена в планировщик.
create_preset_reports Инициализирует системные отчеты по шаблонам (presets).
delete Удаляет запись отчета или пресета по ID.
deploy Возвращает отчет о развертывании (deployment report) с фильтрацией по локации, периоду и типам инфраструктуры.
deploy_journal Возвращает список записей из журнала развертывания с данными о локации.
deploy_journal_update Обновляет статус или детали записи в журнале развертывания (завершение задачи, назначение сотрудника и т.д.).
deploy_stall_list Возвращает список записей о задержках (stalls) в процессе развертывания.
employees Возвращает список сотрудников, входящих в команду текущего пользователя.
execute Выполняет команду (execution) для конкретного объекта.
execute_all Запускает массовую задачу выполнения (например, генерация отчетов) с указанием количества итераций.
export Экспортирует данные в формате CSV на основе переданных строк и заголовков.
generate_daily Запускает процесс генерации ежедневных отчетов для указанного ID.
get_convertions Получает данные по конверсиям с фильтрацией по UTM-меткам и датам.
get_convertions_filter Возвращает список доступных значений для фильтрации отчетов по UTM-меткам.
get_data Возвращает детальные данные объекта (отчет) по его ID.
idle Возвращает список серверов, которые находятся в режиме ожидания (не в fleet).
infra Возвращает отчет по состоянию инфраструктуры.
invoice_report Генерирует и отдает CSV-файл с детальной информацией по инвойсам за указанный период.
licenses Возвращает список лицензий с учетом фильтрации по семейству продуктов.
list Возвращает список доступных отчетов.
managed_apps_deployed Возвращает отчет по установленным управляемым приложениям.
openstack_nodes Возвращает список узлов и сводную информацию по платформе OpenStack.
ovirt_ip Возвращает список IP-адресов, связанных с виртуализацией OVIRT.
ovirt_nodes Возвращает список узлов и сводную информацию по платформе OVIRT.
pdu Возвращает отчет по устройствам распределения питания (PDU) для указанной локации.
port_of_virt_node Возвращает список портов для виртуальных узлов в указанной локации.
power_consumption Возвращает отчет по энергопотреблению.
presets_calculate_roi Запускает процесс расчета окупаемости (ROI) для пресетов.
presets_get_roi Возвращает данные о показателях ROI для пресетов.
presets_get_roi Возвращает данные о рентабельности (ROI) для различных компонентов.
registrations Возвращает список регистраций (экспорт в CSV).
show Возвращает детализированную информацию по конкретному отчету.
sms_log Возвращает список записей журнала отправки SMS-сообщений с пагинацией.
suspension_journal Возвращает список записей журнала приостановки услуг с применением фильтрации.
timetable Возвращает график работы (таймлайн) сотрудника.
tplatforms Генерирует отчет использования T-платформ за указанный период.
traffic_invoices Возвращает детализацию использования трафика, сгруппированную по валютам.
traffic_usage Возвращает отчет об использовании трафика серверами с возможностью шейпинга (ограничения).
try Выполняет пробный (test) запуск метода report_try с переданными параметрами.
update Обновляет данные в отчете по указанному ID с использованием переданных параметров.
update_ltv Запуск процесса обновления показателей LTV (Lifetime Value). Метод является устаревшим и вызывается по расписанию.
update_racks_power Обновляет теги энергопотребления для стоек (среднее, теоретическое и максимальное значения) на основе текущих данных.
user_control_locks Возвращает список записей о блокировках/управлении пользователями.
vat_report Генерирует отчет по инвойсам с учетом налогов (VAT) для указанного региона и периода.
whmcs_services Получает список сервисов из системы WHMCS для сверки с локальными данными.
windows_ip Возвращает список IP-адресов серверов с лицензионным ПО Windows для активации.
yookassa_refund_journal Возвращает список записей о возвратах через систему YooKassa за указанный период.

res_proxy.php

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

Метод Описание
add_new_plan Создает новый тарифный план с указанием лимитов и стоимости в различных валютах.
create_config Создает новую конфигурацию прокси-серверов с заданными параметрами (страна, протокол, количество) и возвращает обновленный список доступных конфигураций.
delete_config Удаляет существующую конфигурацию прокси-серверов по её ID.
delete_plan Удаляет существующий тарифный план по его ID.
delete_user Удаляет пользователя из системы.
get_cities Возвращает список доступных городов для выбранной страны и региона.
get_configs Возвращает список конфигураций прокси для клиента.
get_params Возвращает доступные параметры конфигурации прокси для пользователя
get_plan_history Возвращает историю изменений конкретного тарифного плана
get_plan_users Возвращает список пользователей, привязанных к тарифному плану
get_regions Возвращает список доступных регионов для указанной страны
list_plans Возвращает список всех доступных тарифных планов
regenerate_config Запускает процесс регенерации параметров сессий для указанной конфигурации.
resume_user Возобновляет действие заблокированного пользователя
suspend_user Приостанавливает действие пользователя (блокирует доступ) по указанной причине.
update_config Обновляет параметры существующей конфигурации резидентных прокси (название, страна, протокол, количество и тип).
update_plan Изменяет параметры тарифного плана: название, статус, лимиты и стоимость в разных валютах.
update_stats Запускает процесс пересчета системной статистики прокси-серверов.

revolut.php

(описание будет добавлено при генерации)

Метод Описание
check Проверяет текущий статус платежа по идентификатору заказа в системе Revolut.
confirm Завершает процесс обработки заказа, если его статус в Revolut соответствует завершенному платежу.
init Инициирует процесс оплаты для конкретного счета (invoice), проверяя доступность валюты.

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 хранилищем: создание бакетов, управление аккаунтами пользователей, удаление данных и администрирование тарифов

Метод Описание
activate_user Активирует S3 аккаунт (снимает блокировку/суспенд). Используется в административном сценарии.
cancel_payment_account_deletion Отменяет процесс удаления сервиса и восстанавливает статус аккаунта.
clone_plan Создает новый тарифный план на основе существующего с указанием нового имени.
create_bucket Создает новый S3 бакет для указанного пользователя.
create_order Создает новый S3 аккаунт и привязывает его к тарифному плану.
create_plan Создает новый тарифный план S3 с заданными параметрами стоимости и лимитов.
delete_account Полное удаление S3 аккаунта и связанных с ним сервисов.
delete_bucket Удаляет указанный S3 bucket.
delete_file Удаляет конкретный файл из S3 бакета.
delete_journal_node Удаляет все записи в журнале (nodes) для указанного идентификатора. Доступно только администраторам.
delete_payment_account Инициирует процесс удаления (отмены) сервиса и подписки.
delete_plan Удаляет тарифный план, если у него нет активных пользователей.
export_users_to_csv Экспортирует список всех пользователей текущего тарифного плана в формате CSV.
fill_tariff_periods Запускает процесс заполнения/обновления тарифных периодов в базе данных.
get_available_locations Возвращает список всех доступных локаций, настроенных в S3 планах.
get_buckets_rmq Возвращает список бакетов и информацию по использованию через RMQ.
get_files Возвращает список файлов и папок в указанном бакете с поддержкой пагинации.
get_plan_mrr_dynamics_report Возвращает отчет по динамике ежемесячной повторяющейся выручки (MRR) для конкретного S3 плана за указанный период.
get_report Возвращает детализированный отчет по использованию ресурсов (трафик, хранилище) для конкретного плана или региона.
get_storage_dynamics_report Возвращает отчет по динамике использования объема хранилища за последние N дней.
get_users Возвращает список пользователей (аккаунтов) для конкретного плана или клиента.
history Возвращает историю событий, связанных с конкретным S3 аккаунтом или планом.
list_plans Возвращает список доступных тарифных планов с учетом налогов (VAT) и валюты пользователя.
metering Принимает сырые данные метрик (raw body) для сохранения в систему биллинга.
metering_faker Генерирует и сохраняет тестовые (фейковые) данные метрик для указанных S3 аккаунтов.
metering_faker_calculate Выполняет расчет перерасхода (overage) на основе сгенерированных или существующих данных за период.
remove_free_s3 Удаляет все бесплатные (бета) аккаунты S3 в системе.
show_key Возвращает расшифрованный Access Key или Secret Key для указанного S3 аккаунта.
suspend_free_s3 Приостанавливает работу всех бесплатных (бета) аккаунтов S3.
suspend_user Приостанавливает работу конкретного S3 аккаунта.
tariff_upgrade Инициирует процесс перехода с бесплатного S3 на платный тариф.
tariff_upgrade_execute Выполняет техническую часть перехода на платный тариф.
update_plan Создает новый или обновляет существующий тарифный план S3.
update_quota Выполняет системную процедуру обновления лимитов (квот) для всех аккаунтов.
update_reason_suspend Обновляет причину приостановки S3 аккаунта для административного контроля.
update_traffic_info Возвращает текущие метрики использования трафика для S3 аккаунта.

saas.php

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

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

software.php

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

Метод Описание
all_software Возвращает полный список всего доступного программного обеспечения с учетом региональных ограничений (RU/non-RU).
app_marketplace Возвращает пустой успешный ответ для инициализации маркета приложений.
list Возвращает список доступного программного обеспечения, отфильтрованного по параметрам сервера или локации пользователя.
presets Возвращает список подходящих пресетов (конфигураций) для выбранного программного обеспечения, а также список совместимых операционных систем.

ssh_keys.php

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

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

stocks.php

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

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

stripe.php

(описание будет добавлено при генерации)

Метод Описание
init Создает объект PaymentIntent в Stripe для оплаты счета WHMCS. Поддерживает создание клиента в Stripe, если он еще не существует.

sumsub.php

Интеграция с сервисом Sumsub KYC для управления верификацией пользователей и отправки приглашений на прохождение проверки.

Метод Описание
check Выполняет проверку статуса верификации через Sumsub API (тестовый режим).
get_token Запрашивает временный access token для работы с Sumsub SDK.
send_request Отправляет пользователю ссылку на прохождение верификации Sumsub.

tags.php

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

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

tags_mgr.php

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

Метод Описание
add Создает новую запись тега или связанную сущность
assist Запуск интеллектуального помощника по управлению тегами
components Возвращает список доступных компонентов для тегов
delete Удаляет тег или связанные с ним записи
duplicates Возвращает список обнаруженных дубликатов тегов
edit Обновляет существующий тег или его параметры
entities Возвращает список всех сущностей, связанных с тегами
export Запуск процесса экспорта тегов в файл или формат данных
histories Получение истории действий и изменений тегов
import Загрузка и импорт новых тегов из внешнего источника
list Получение списка всех доступных тегов с фильтрацией
merge Объединение нескольких тегов в один для устранения дубликатов
news Получение ленты новостей системы тегов
view Детальная информация о конкретном теге

traffic_plans.php

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

Метод Описание
add Создает новый тарифный план трафика с заданными лимитами и стоимостью.
list Возвращает список тарифных планов, подходящих для конкретного сервера (по ID) или доступных в определенной локации.
remove Удаляет существующий тарифный план по его ID.
update Обновляет параметры существующего тарифного плана.

triggered_mailings.php

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

Метод Описание
create Создает новый шаблон триггерного письма с указанием темы и текста на двух языках.
delete Удаляет существующий шаблон по его ID.
get_settings Возвращает текущие настройки рассылок (список email).
list Возвращает список всех доступных шаблонов рассылок.
read Возвращает детальную информацию о конкретном шаблоне по его ID.
save_settings Обновляет список email-адресов для рассылок.
update Обновляет данные существующего шаблона.

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 и др.).

vat.php

(описание будет добавлено при генерации)

Метод Описание
check_vat Проверяет валидность налогового номера (VAT) в системе VIES. Если проверка успешна, клиенту присваивается тег верификации.

vlans.php

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

Метод Описание
add Создает новый VLAN в системе.
add_history Добавляет запись о событии в историю изменений VLAN.
delete Удаляет существующий VLAN.
history Возвращает список записей истории для указанного VLAN.
list Возвращает список всех VLAN с возможностью фильтрации.
show Возвращает детальную информацию о конкретном VLAN.
update Обновляет параметры существующего VLAN.

vm.php

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

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

waybills.php

API модуль управления накладными (waybills): создание, редактирование, управление деталями, штрих-кодами и историей событий.

Метод Описание
add Создает новую накладную на основе переданных параметров фильтрации.
add_barcodes Добавляет массив штрих-кодов к существующей накладной.
add_history Добавляет примечание (запись) в историю накладной.
add_rows Добавляет новые строки (детали) в существующую накладную.
complete Переводит накладную в статус завершенной.
delete Удаляет накладную.
delete_barcodes Удаляет указанные штрих-коды из накладной.
delete_rows Устанавливает статус DELETED для указанных строк накладной.
fail Устанавливает статус FAILED для всей накладной.
fail_rows Устанавливает статус FAILED для указанных строк накладной.
finalize Завершает процесс обработки накладной.
history Возвращает историю событий для указанной накладной или по фильтрам.
history_rows Возвращает историю изменений конкретных строк накладной.
list Возвращает список накладных с применением фильтров.
list_barcodes Возвращает список штрих-кодов, соответствующих заданным фильтрам.
list_rows Возвращает список строк (деталей) конкретной накладной.
modify Обновляет данные существующей накладной.
modify_hardware Выполняет аппаратную модификацию накладной (добавление/удаление компонентов).
modify_rows Синхронизирует статус строк накладной, переводя их в режим ручного управления (MANUAL).
rocket_channels Возвращает список доступных каналов отправки сообщений в зависимости от локации.
send_rocket_message Отправляет уведомление через каналы Rocket для указанной накладной.
show Возвращает подробную информацию о конкретной накладной по её ID.
update Обновляет основные данные существующей накладной.
update_rows Обновляет набор строк (деталей) внутри указанной накладной.

website.php

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

Метод Описание
add_preorder Создает новый предзаказ (preorder) для клиента. Если клиент не найден, пытается найти его по email и billing.
billings Возвращает список доступных локаций биллинга (WHMCS) с информацией о компаниях и платежных методах.
check_email Проверяет, зарегистрирован ли данный email в системе InvAPI или WHMCS.
clear_cache Очищает кэш веб-сайта. Позволяет указать конкретный сайт и массив целей для очистки.
get_email Возвращает email клиента, привязанного к конкретному ID аккаунта в указанной локации.
get_ip_pricing Возвращает актуальные цены на услуги с учетом валюты, привязанной к IP-адресу.
get_pids Возвращает карту соответствия ID локаций WHMCS и внутренних идентификаторов системы.
get_stop_words Возвращает список стоп-слов для фильтрации текста.
order Создает заказ (prebill или прямой) на основе корзины товаров.
ovirt_ip Возвращает значение extra для тега ovirt_ip.
preorder_x_send_email Отправляет уведомление клиенту о доступности сервера из преордера.
rate Возвращает список доступных тегов/курсов.
set_event Сохраняет данные гостя в таблицу hkclients.
validate_ip Возвращает информацию о геолокации и типе IP (hosting, anonymous).
validate_tel Проверяет корректность и формат предоставленного номера телефона.

whmcs.php

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

Метод Описание
add_addon Добавляет дополнительную услугу (addon) в WHMCS для существующего сервера.
add_cancel_request Создает запрос на отмену услуги (cancellation request) для сервера.
add_client Создает нового клиента в WHMCS с привязкой к локации.
add_client_from_billing Создает клиента в системе на основе данных существующего пользователя из WHMCS.
add_client_note Добавляет административную заметку к профилю клиента.
add_contact Добавляет дополнительного контактного лица к клиенту.
add_credit Начисляет кредит (баланс) на счет клиента в WHMCS.
add_invoice_payment Применяет платеж к конкретному инвойсу.
add_order Создает новый заказ в WHMCS.
add_os_addon Добавляет лицензию операционной системы как addon к существующему серверу.
apply_credit Применяет средства с баланса аккаунта к оплате конкретного инвойса.
apply_credit_to_invoice Применяет доступный баланс клиента (кредит) для оплаты указанного инвойса.
cancel_order Отменяет заказ в WHMCS, если он находится в статусе Pending/Unpaid и не содержит активных лицензий.
change_billing_cycle Изменяет цикл оплаты (например, с ежемесячного на годовой) для сервера.
change_preset Инициирует процесс смены конфигурационного пресета сервера.
check_hosting_to_move Проверяет возможность переноса хостинг-услуги.
client_change_billing_cycle Позволяет клиенту самостоятельно сменить цикл оплаты (например, на более длинный).
clone Клонирует данные клиента из одного биллинга в другой.
create_addfunds Создает инвойс для пополнения баланса (Add Funds) в WHMCS.
create_invoice Создает новый инвойс в WHMCS на основе переданных параметров.
create_product_invoice Создает инвойс для конкретного продукта (услуги) в WHMCS.
delete_cancellation_request Удаляет существующий запрос на отмену услуги.
delete_client_note Удаляет конкретную заметку из профиля клиента.
delete_contact Удаляет дополнительный контакт пользователя из WHMCS.
delete_credit_item Удаляет запись о кредите (начислении) для клиента.
delete_email Удаляет существующий шаблон электронного письма из WHMCS.
delete_from_invoice Удаляет указанные позиции (items) из существующего инвойса.
download_invoice Возвращает PDF-файл инвойса в формате base64.
email_template_add Создает новый шаблон электронного письма в WHMCS.
email_template_delete Удаляет шаблон электронного письма из WHMCS.
email_template_get Возвращает данные существующего шаблона электронного письма.
email_template_update Обновляет содержимое или настройки существующего шаблона письма.
email_templates_lang_add Добавляет новую языковую версию для существующего шаблона email в WHMCS.
email_templates_lang_disable Отключает указанную языковую версию шаблона email.
email_templates_lang_list Возвращает список доступных языков для шаблонов email.
email_templates_list Возвращает список всех доступных шаблонов email в WHMCS.
email_templates_lists Возвращает структурированный список шаблонов, сгруппированных по их типу (General, User, Invoice и т.д.).
email_templates_search Поиск шаблонов email по типу или языку.
generate_due_invoice Принудительно генерирует следующий инвойс для сервера в WHMCS.
get_billing_data Возвращает подробную информацию о текущем биллинге, включая данные EU B2C и лицензии.
get_cancellation_requests Возвращает список активных запросов на отмену для сервера или пользователя.
get_client Возвращает подробную информацию об авторизованном клиенте, включая данные из WHMCS и внутренние теги.
get_client_note Возвращает список всех заметок, оставленных администратором для конкретного клиента.
get_clientgroups Возвращает список доступных групп клиентов из WHMCS для указанной локации.
get_clients Возвращает список клиентов с фильтрацией по статусу.
get_contacts Возвращает список дополнительных контактов для указанного клиента.
get_currencies Возвращает список доступных валют в WHMCS для указанной локации.
get_emails Возвращает список email-адресов, связанных с клиентом.
get_hosting_to_move Возвращает данные о хостинге, доступном для переноса (deprecated).
get_invoice Возвращает данные конкретного инвойса из WHMCS.
get_invoice_tags Возвращает список всех тегов, связанных с конкретным инвойсом.
get_invoices Возвращает список всех инвойсов клиента.
get_migration_progress Возвращает статистику по статусам пользователей в процессе миграции.
get_not_delivered_emails Возвращает список email-сообщений, которые не были доставлены.
get_order_to_move Возвращает данные о заказе (order) для процесса переноса между биллингами.
get_owners Возвращает данные о владельцах для списка ID оборудования.
get_product_invoice Возвращает список всех инвойсов, связанных с конкретным продуктом (сервером).
get_products Возвращает список доступных продуктов для указанной группы (gid).
get_promotions Возвращает список доступных промокодов или проверяет валидность конкретного кода.
get_refunds Возвращает список возвратов средств для указанного аккаунта или сервера.
get_refusal_report Возвращает отчет по отказам (refusals) за указанный период.
get_related_invoices Возвращает список всех инвойсов, привязанных к аккаунту клиента.
get_server_config Возвращает конфигурационные данные сервера из WHMCS.
get_service Возвращает детальную информацию о конкретном сервисе (сервере).
get_services Метод помечен как устаревший. Работает через планировщик.
get_upgrade_preset_cost Возвращает список цен на различные конфигурации (пресеты) для улучшения сервера.
getcredits Возвращает информацию о доступных средствах (кредитах) на аккаунте клиента.
getpaymentgw Возвращает список доступных методов оплаты для конкретного инвойса.
mass_pay Создает один общий инвойс для массовой оплаты нескольких выбранных инвойсов.
merge_invoices Объединяет несколько инвойсов в один.
notify_reinstall_issues Отправляет уведомление клиенту, если при переустановке сервера возникли проблемы.
notify_resource_overuse Отправляет уведомление клиенту о превышении лимитов потребления ресурсов сервера.
payment_to_month_first_day Настраивает дату платежа сервера на первый день месяца.
preview_billing_cycle_change Выполняет предварительный расчет стоимости и параметров при изменении периода оплаты (например, с ежемесячной на годовую) без сохранения изменений в базе данных.
preview_client_billing_cycle_change Рассчитывает стоимость и детали при смене платежного цикла клиентом.
refund_check Проверяет, находится ли запрос на возврат в процессе обработки (через статус тикета JIRA).
refund_check_payment_paygine Проверяет статус и возможность выполнения возврата через платежный шлюз Paygine.
refund_check_payment_yookassa Проверяет статус и возможность выполнения возврата через платежный шлюз ЮKassa.
refund_payment Выполняет возврат средств через транзакцию в WHMCS.
refund_payment_paygine Инициирует процесс возврата средств через шлюз Paygine.
refund_payment_yookassa Инициирует процесс возврата средств через шлюз ЮKassa.
remove_credit Удаляет кредит (баланс) с аккаунта клиента в WHMCS.
remove_credit_from_invoice Удаляет сумму кредита, примененную к конкретному счету (инвойсу).
request_cancellation Инициирует процесс отмены сервера и проверяет условия (наличие задолженностей, статус лицензий).
request_refund Инициирует процесс возврата неиспользованных денежных средств с баланса клиента. Проверяет наличие открытых тикетов в JIRA и лимиты кредитного баланса в WHMCS.
request_subscription_cancellation Запрашивает отмену автоматического продления (подписки) банковской картой.
resend_email Повторно отправляет письмо, связанное с объектом (например, уведомление о регистрации).
reset_login_failures Сбрасывает счетчик неудачных попыток входа для всех пользователей.
reset_password Инициирует процесс сброса пароля клиента. Если токен уже использован, позволяет установить новый пароль.
search_client Поиск клиентов по имени или email во всех доступных локациях WHMCS.
search_invoice Поиск инвойсов по ID во всех локациях WHMCS.
send_email Отправка кастомного письма клиенту.
send_notifications_to_list Отправляет кастомные email-уведомления выбранному списку клиентов через WHMCS или SMTP.
split_invoice Разделяет существующий инвойс на несколько частей по указанным ID позиций.
toggle_billing_lock Устанавливает или снимает тег блокировки изменения цикла оплаты для сервера.
transactions Возвращает список финансовых транзакций клиента.
trustpilot_mail Отправляет специальное письмо для запроса отзыва на Trustpilot.
unified_search Поиск по всем сущностям: сервера, клиенты, инвойсы, VAT.
unpaidinvoices Запускает процесс обхода неоплаченных инвойсов в WHMCS для отправки напоминаний клиентам.
update_client Обновление данных профиля клиента в WHMCS и локальной базе.
update_client_note Обновляет существующую заметку в профиле клиента.
update_contact Обновление данных дополнительного контакта клиента.
update_credit_item Обновляет данные конкретной записи о кредите (сумма, описание) для клиента.
update_invoice Обновляет данные существующего инвойса в WHMCS, включая возможность удаления строк (items).
update_product Обновление параметров сервера (статус, дата продления, домен и т.д.).
update_traffic Обновляет параметры биллинга трафика для сервера (лимиты, периоды и стоимость).
updatevat Запускает процесс обновления налоговых данных в WHMCS.
vat_report Возвращает отчет по налогам (VAT) за указанный период.
verify_address Проверяет адрес клиента через Google Maps API для подтверждения его корректности.
verify_email Проверяет корректность email-адреса и отправляет код верификации или подтверждает изменение почты.
welcome_code Генерирует MD5 хеш на основе email клиента для верификации.

whmcs_hooks.php

(описание будет добавлено при генерации)

Метод Описание
ClientAdd Обрабатывает создание нового клиента в WHMCS, отправляет приветственное письмо и автоматически переводит клиента в тестовую группу при использовании Hostkey email.
InvoiceCreation Вызывается при создании нового инвойса в WHMCS для инициализации связанных процессов.
client_payment Обрабатывает callback от платежной системы. Проверяет токен безопасности и выполняет финансовые операции через PaymentCallbackHandler.
invoice_total_updated Вызывается при изменении итоговой суммы счета. Выполняет пересчет кредитов (rebalance) в системе.
whmcs_invoice_created Вызывается при создании нового счета в WHMCS. Инициирует процесс создания заказа и уведомляет клиента.
whmcs_invoice_paid Обработка события оплаты инвойса: проверка заказа, очистка перерасхода трафика и уведомление клиента.
whmcs_invoice_reminder Вызывается при отправке напоминаний о неоплаченном счете. Инициирует уведомление клиента.

yookassa.php

Интеграция с сервисом ЮKassa для обработки платежей, инициализации сессий оплаты и синхронизации транзакций

Метод Описание
check_payment Проверяет статус платежа в ЮKassa и при успешной оплате обновляет данные инвойса и создает транзакцию в системе.
init Создает платежную сессию в ЮKassa для конкретного инвойса и возвращает токен подтверждения.
sync_payments Запускает процесс синхронизации всех активных биллингов с ЮKassa для проверки статусов транзакций.
question_mark
Я могу вам чем-то помочь?
question_mark
ИИ Помощник ×