Это старая версия документа!
Список параметров API
A
accept_domain
– подтверждение владельца домена о желании выполнить его трансфер к нам на обслуживание, используется в методе Подача заявки на трансфер домена к нам,1
– подтвердить,0
— отказаться.accept_offer
– соглашение с условиями договора при выполнении его трансфера к нам на обслуживание, используется в методе Подача заявки на трансфер домена к нам,1
– согласиться,0
— отказаться.access_id
– идентификатор делегированного доступа, используется в методах: Настройки уведомлений делегированных услуг, Предоставление доступа к почтовым ящикам для уже делегированной услуги.access_order
– переключение режима ограничения доступа, используется в методе Настройки ограничения доступа,allow
— разрешить доступ всем, кроме указанных вip
IP адресов,deny
— запретить доступ всем, кроме указанных вip
IP адресов.account_id
– идентификатор хостинг-аккаунта. Может быть получен в методах: Получение списка хостинг-аккаунтов, Получение ID записи по значению.account_title
– задание пользовательского названия для хостинг-аккаунта, используется в методе Редактирование названия хостинг аккаунта.act_id
– идентификатор акта выполненных работ. Используется в методе Получение акта выполненных работ в формате PDF.action
– определение типа действия, для каждого метода допустимые значения разные и указаны дополнительно.active
– включение или отключение функционала.additional_info
– дополнительная информация указываемая в заявке на продажу домена.admin_email
– почтовый ящик для уведомлений выполнения cron задачи. Следует оставить пустым для отключения уведомлений.alias
– массив наименования алиаса, используется в методе изменения параметров ''.bashrc''.aliases
– псевдонимы(алиасы) сайта, используется для указания псевдонимов в сертификате Let`s encrypt во время установки или обновления.allow_custom_sender
– настройка почтового домена для разрешения отправки писем от других пользователей в пределах своего доменного имени,0
— отправка запрещена,1
— отправка разрешена.amount
– сумма выставляемого счета для пополнения баланса учетной записи.area
autoresponder_enabled
– включение или отключение автоответчика,1
– включен,0
– выключен, при создании или изменении настроек почтового ящика.autoresponder_text
– текст писем автоматического ответа, при создании или изменении настроек почтового ящика.autoresponder_title
– заголовок для писем автоматического ответа, при создании или изменении настроек почтового ящика.
B
backup_ftp_wrap
– переключение режима ограничения доступа FTP хранилища. Используется в методах управления ограничениями FTP хранилища выделенных и виртуальных серверов.0
— разрешить доступ всем, игнорируя указанные IP в список,1
— запретить доступ всем, кроме указанных IP адресов.backup_id
– идентификатор ежедневной автоматической резервной копии, список которых можно получить вывев список резервных копий. Используется в методе activate_ftp_access.backup_object
– тип и дата резервной копии, используется в следующем виде:12345@datetype
, где12345
— идентификатор источника (необходимой ежедневной копии или сервиса), аdatetype
— нужный тип копии. Используется в методе Создание заявки получения или восстановления резервной копии.bot_list
box_id
– идентификатор почтового ящика, используется для изменения настроек почтового ящика. Получить его можно используя методы Получение списка почтовых ящиков, Получение ID объекта по его названию.box_password
– пароль от почтового ящика стороннего сервиса, используемый для импорта писем со стороннего сервиса.by
– принцип сортировки, в большинстве методов принимает в качестве значенийasc
иdesc
.
C
card_expire
– дата окончания срока действия кредитной карты, используется для оплаты счета через LiqPay.card_id
– идентификатор добавленной кредитной карты, используется для оплаты счета через LiqPay, настройки автопродления, оплату по токену LiqPay.card_number
– номер кредитной карты, используется для оплаты счета через LiqPay.catch_non_exist
– указание перенаправления почты поступающей на несуществующие почтовые ящики. Принимает значения:0
— возвращать отправителю (удалять) или идентификатор почтового ящика — перенаправлять в почтовый ящик с указанным идентификатором.charset
– указание кодировки базы данных перед импортом.child_ns_id
– идентификатор дочерних NS, используется в методах создания\редактирования и удаления дочерних NS.collation_id
– идентификатор кодировки базы данных указываемый при ее создании.command
– массив наименования алиаса в изменении параметров ''.bashrc''.comment
– комментарий к создаваемой\редактируемой cron задаче.confirm_code
– код подтверждения, используется для оплаты счета через LiqPay.contact_auth_code
– код контакта указываемый для трансфера к нам, можно оставить пустым, если не применяется.contacts
– контакты для связи указываемые при продаже домена.content
– содержимое парковочной страницы.control
– указание действия для включения, перезагрузки, выключения VPS.create_current_backup
– создание резервной копии текущей версии, перед восстановлением запрошенной копии.create_user
– создание пользователя при создании базы данных.currency
– валюта указываемая в счете для Swift платежа.currency_id
– идентификатор необходимой валюты при работе с заявкой продажи домена.current
– добавление IP адреса, с которого производился запрос на изменение пароля, в список разрешенных для подключения к SSH.cvv2
– cvv2 код, используется для оплаты счета через LiqPay.
D
dark_logo_url
– адрес темного логотипа для кастомизации Webmail.data_type
– тип удаляемой записи из белого\черного списка почты.dates
– интервал времени указываемый для списка освобожденных доменов или массив дат используемый в списке медленных SQL запросов.day
– значение дня в расписании запуска cron заданий.day_limit
– лимит импортируемых писем по количеству дней.db_id
– идентификатор базы данных, можно получить методами: Получение ID по имени, Получение списка баз данных хостинг-аккаунта.db_name
– имя базы данных MongoDB используемое в создании базы данных или пользователя.dedicated_id
– идентификатор выделенного сервера, можно получить методом Получение ID по имени.default_host
– параметр в настройках сайта, указывающий обрабатывать все запросы, поступающие на несуществующие субдомены.default_ip
– параметр в настройках сайта, указывающий обрабатывать запросы, поступающие на выделенный IP адрес.deny_remote_link
– расширения файлов, к которым запрещен доступ системой hotlink.disable_service_url
– отключение сервисного адреса в настройках сайта.distr_id
– идентификатор устанавливаемого дистрибутива при заказе VPS.document_root_suffix
– настройка DocumentRoot в настройках сайта.domain
– доменное имя.domain_auth_code
– Auth-code для трансфера домена на наше обслуживание.domain_id
– идентификатор домена, можно получить методами: Получение ID по имени, Получение списка доменов.domain_name
– доменное имя.domains
– массив доменных имен, которые необходимо добавить для отслеживания освобождения.domains_search_request
– фильтр списка доменных имен по указанному значению.
E
egrpou
– ЕГРПОУ для анонимной оплатыemail
– почтовый ящик, используется для изменения пароля почтовых ящиков и подписки на уведомления об освобождении домена.email_id
– идентификатор почтового ящика, используемого для получения писем отправляемых на несуществующие ящики.email_redirect
– целевой почтовый ящик для редиректа писем.extra_mail_space
– размер выделяемого дополнительного дискового пространства для почты, устанавливается в пределах от 10 до 10 000 ГБ.extrassd
– размер выделяемого дополнительного дискового пространства, устанавливается в пределах от 1 до 100, где 1 это 500МБ, а 100 это 50 000 МБ.
F
form_name
ftp_id
– идентификатор FTP пользователя, можно получить методами: Получение ID по имени, Получение списка доменов.
H
host
– массив идентификаторов используемый для массового удаления сайтов.host_id
– идентификатор сайта, можно получить методами: Получение ID по имени, Получение списка сайтов аккаунта.hostname
– поддомен для дочерних NS или персонального Webmail, либо хост для обратной PTR записи IP выделенного сервера.hotlink_allow_direct_request
– разрешить прямые запросы к ресурсам защищенным системой HotLink.hour
– значение часа в расписании запуска cron заданий.http2_push_preload
– управление параметром Server Push в настройках сайта.http_blacklist_disabled
– отключение защиты от ботов в настройках сайта,0
– отключить защиту,1
– включить защиту.https_redirect
– установка HTTP(S) редиректа в настройках сайта, принимает следующие значения:disabled
– отключить редирект,to_http
– переадресовывать все запросы на HTTP,to_https
– переадресовывать все запросы на HTTPS.
I
import_limit
– лимит импортируемых писем из другого ящика. Указывается какall
для импорта всего или какday
для ограниченного импорта.import_records
– импорт записей, при добавлении в систему домена зарегистрированного не у нас.index_id
– идентификатор индекса, используется в редактировании и удалении крон задания на автоматическое обновление индекса Sphinx.interval
– интервал обновления услуги мониторинга для Dedicated сервера.invoice_id
– идентификатор выписаного ранее счета, получить список всех счетов можно с помощью метода Получение списка счетов.ip
– в зависимости от метода данные в данном параметре передаются в виде массива или же отдельный строки. В каждом методе указывается необходимый тип данных.ipv6
– указание IPv6 адреса для дочерних NS.ipv6_auto_configuration
– параметр в настройках сайта,is_force
is_mailbox
– параметр определяющий предоставление доступа к почтовым ящикам при делегировании доступа или предоставлении доступа к ящикам.is_notification
– включение или отключение уведомлений о делегированной услуге.is_readonly
– управление доступами FTP пользователя при создании или редактировании:0
— доступ на чтение и запись,1
— доступ только на чтение.is_restore
– параметр восстановления создаваемой резервной копии. При установке в 1 копия не будет доступна для скачивания, но сразу же будет восстановлена в рамках указанного сервиса, если это возможно.item_id
– идентификатор заказаной услуги в корзине, используется для изменения периода оплаты или удаления из корзины.
K
key
– SSH ключ, используемый для добавления на сервер.key_id
– идентификатор SSH ключа, используемый для его удаления с сервера.
L
light_logo_url
– ссылка на файл светлого логотипа для создания кастомизированного webmail.limit
– значение пользовательского лимита на отправку писем, для всех почтовых ящиков аккаунта.limit_force
– значение временного повышения лимита на отправку писем.link_id
– идентификатор добавленных страниц защиты от ботов, используемый для их удаления.list
login
– имя\название различных услуг.
M
mailbox_id
– идентификатор почтового ящика для просмотра лога авторизаций в нем.memcache
– объем памяти при заказе memcache.memory
– объем памяти при заказе redis.minute
– значение минут в расписании запуска cron заданий.modsecurity_disable_rules
– отключенные правила ModSecurity устанавливаемые в настройках сайта.modsecurity_enabled
– включение\отключение ModSecurity устанавливаемое в настройках сайта.month
– значение месяца в расписании запуска cron заданий.mysql
– идентификатор целевой базы данных и пользователя базы данных, используемые для импорта. Указывается в видеuserid_dbid
, где userid идентификатор пользователя, аdbid
идентификатор базы данных. Оба значения можно получить методом Получение списка баз данных хостинг-аккаунта.mysql_user_id
– идентификатор пользователя базы данных. Значение можно получить методом Получение списка баз данных хостинг-аккаунта.mysql_version_id
– идентификатор необходимой версии Mysql для изменения на Бизнес-хостинге.mysql_wrap_active
– Включение или отключение доступа по IP к базам данных,1
ограничение включено,0
ограничение выключено.
N
name
new_plan_id
– идентификатор тарифного плана используемый для изменения.
O
object_name
– выводимое имя для отображения в списке заказов заявок создания резервных копий.opcache
– объем памяти при заказе opcache.optimize
– массив правил pagespeed из настроек оптимизации, устанавливаемых в настройках сайта.os_id
– идентификатор ОС для автоматической установки на выделенный сервер.
P
page
– фильтрация выводимой информации по страницам. В этом параметре указываются необходимая для вывода страница.pagespeed_exceptions
– список ссылок, разделенных запятой, к которым не будут применяться правила модуля оптимизации pagespeed. Устаналивается в настройках сайта.params
passwd
– пароль для различных служб хостинга.passwd_new
– новый пароль, указываемый при изменении старого.passwd_new_confirm
– повторное указание нового пароля для изменения старого в почтовом ящике.password
– пароль для различных служб хостинга.pay_type
– тип проводимого платежа для банковских карт, используются два значения:pay
– полноценная оплата счета,auth
– авторизация и добавление карты (происходит списание 1 грн и ее возврат).period
– период продления или заказа услуги.phone_id
– идентификатор телефонного номера, привязанного к учетной записи, используемый для оплаты счёта через Приват24.php_disable_functions
– отключенные функции PHP, используется в настройках PHP сайта.php_fpm_template
– шаблон настроек php-fpm для разных CMS. Допустимые значения:default
,wordpress
,opencart
,dokuwiki
,modx
,moodle
php_mail
– почтовый ящик, указываемый в настройках сайта, созданный на хостинге, для подстановки в поле «Отправитель»(FROM) письма, отправляемые без авторизации.php_version
– версия PHP для установки в .bashrc для консоли.plan_id
– идентификатор тарифного плана услуг.port
– номер порта или массив портов, используется в блокировке исходящих соединений, импорте почты, добавлении SRV записи и открытии портов исходящих соединений.price
– цена на доменное имя, при создании заявки на его продажу.python_version
– версия Python для установки в .bashrc для консоли.
Q
queue_id
— идентификатор заявки на создание или восстановление резервной копии. Для получения используется метод queue_list
R
reason
— причина удаления доменного имени.receiver_email
— почтовый ящик получателя, при передаче доменного имени.receiver_id
— идентификатор получателя, при передаче доменного имени.record
— данные доменной записи, указываемые при ее добавлении.redirect
— тип веб редиректа для домена или включение\отключение редиректа писем при создании или редактировании почтового ящика.redirect_to
— переадресация запросов на другую версию сайта, устанавливаемая в настройках сайта. Доступные значения:www_to
— переадресовывать запросы с адреса сайта на его же версию с www;www_from
— переадресовывать запросы с адреса сайта на его же версию без www; укажите адрес сайта видаwww.example.com
илиexample.com
для переадресации всех запросов к сайту, включая запросы к алиасам, на указанную версию;off
— отключение переадресации.redirect_url
— целевой адрес сайта для веб редиректа домена.redis
– объем памяти при заказе redis.revoke_from_user_id
— идентификатор пользователя от которого необходимо отозвать делегированный доступ для услуг хостинга, домена, VPS, выделенного сервера.root_passwd
— устанавливаемый пароль при изменении пароля root пользователя в SSH для VPS.rule_id
— идентификатор правила для включения\отключения в ModSecurity и удаления из белого\черного списка почты.
S
send_notification
server
— сервер донора при импорте почты.service
— сервис указываемый для создания SRV записи.service_id
— идентификатор заказываемой услуги, для удаления\добавления\добавления с выпиской счета сервиса в корзину или удаления из автопродления, а также для выставления счета\отключения\удаления\включения продления дополнительной услуги.service_type
– тип услуги указываемый для анонимной оплаты.show_change_password_link
— отображение ссылки на смену пароля в пользовательском интерфейсе webmail,0
— не отображать,1
— отображать.skip
— параметр указывающий не проверять наличие домена на указываемых NS. Установите1
чтобы не проверять,0
или не указывать — проверка будет производиться.sort
— параметр сортировки, значения зависят от метода.source
— источник или способ, используется в добавлении услуг в автопродление, в качестве способа оплаты,ssl
— параметр определяющий необходимость использования защищенного соединения при переносе почты.ssl_disable_cert_check
— проверять валидность сертификата при переносе почты,0
— проверять,1
— не проверять.ssl_protocols_set
— версии TLS используемые для шифрования соединения с сайтом, доступные параметрыcompatible
— использовать любой TLS 1.0 - 1.3,modern
— использовать только TLS 1.2 - 1.3 .ssl_user_crt
— публичный сертификат устанавливаемый для сайта.ssl_user_key
— ключ сертификата устанавливаемого для сайта.ssl_user_key_pass
— пароль для ключа сертификата, если используется, устанавливаемого для сайта.stack
— Массив с необходимыми NS серверами при их изменении. Индекс массива следует указывать начиная с 1.static_404_redirect
— параметр определяющий передавать ли запрос на backend сервер, в случае, если целевой статический файл не найден, устанавливается в настройках сайта,0
— выключен,1
— включен.static_cors
— добавление заголовка политики CORS, разрешающего доступ со всех доменов, устанавливается в настройках сайта,0
— выключен,1
— включен.static_files
— список расширений которые будут являться статическими и обрабатываться веб сервером nginx. Устанавливается в настройках сайта, в качестве данных передается строка с расширениями, разделенными запятыми.static_files_expire_user
— время задаваемое для кеширования статических файлов в настройках сайта.status
— включение или отключение использования SSL сертификата на сайте,0
— выключен,1
— включен.subdomain
— имя поддомена при добавлении SRV записи.subdomain_id
— идентификатор поддомена при удалении доменной записи.support_url
— ссылка на техническую поддержку или иной сервис в пользовательском интерфейсе webmail.system_error_lang
— язык для страниц ошибок возвращаемых веб сервером, устанавливаемый в настройках сайта, доступные к указанию данные:ru
,en
,uk
.system_error_pages
— включение или отключение страниц ошибок возвращаемых веб сервером, устанавливается в настройках сайта,0
— выключен,1
— включен.
T
tag_free
— флаг отсутствия тегов для получения списка доменов,0
— любые домены,1
— только домены без тегов.task
— коменда cron задания указываемая при добавлении/изменении.task_id
– идентификатор cron задания при редактировании, укажите 0 для создания новой.token
— токен используемый для оплат услуг или получения счета.type
— параметр определяющий тип действий для различных методов.
U
url
— адрес страницы проверяемой мониторингом.url_match_type
— принцип поиска адреса в защите от ботов. Допустимые данные:begins
— в начале,ends
— в конце,contains
— содержит.user_login
— почтовый ящик используемый для делегирования хостинга, домена, VPS, выделенного сервера.user_name
— имя пользователя создаваемой базы данных MongoDB/user_request
— Параметр указывающий на подтверждение удаления учетной записи. Чтобы произвести удаление, нужно указать в этом параметре 1.
V
valid_referers
— адреса ресурсов которым разрешен доступ к защищенным файлам системой HotLink. Указывается в виде строки разделенной запятыми или пробелами.virtual_domain_id
— идентификатор сайта используемый для множества методов, получить можно используя методы: Получение ID по имени, Получение списка сайтов аккаунта.vps_id
— идентификатор VPS сервера, можно получить используя метод получение ID по имени.vps_title
— пользовательское название VPS сервера.
W
web_server_backend
— тип веб сервера устанавливаемый в настройках сайта, доступные параметры:apache
,litespeed
,php-fpm
.webmail_name
— отображаемое имя для персонального Webmail.week
— значение недель в расписании запуска cron заданийweight
— вес для SRV записи.word
— искомое слово на странице проверяемой мониторингом.
Последние изменения
Новые параметры: LMI_PAYMENT_NO
, LMI_PAYEE_PURSE
, LMI_PAYMENT_AMOUNT
, LMI_HASH
, LMI_SYS_INVS_NO
, LMI_SYS_TRANS_NO
, LMI_SYS_TRANS_DATE
, LMI_PAYER_PURSE
, LMI_PAYER_WM
, LMI_PREREQUEST
, LMI_MODE
Новые параметры: confirm
Новые параметры: tm_code
Новые параметры: tag_name
Новые параметры: hosts_id
Удалённые параметры: host
Новые параметры: version_id
Удалённые параметры: box_password
, ie_sort
, passwd_new_confirm
, phone_id
, php_mail_id
, port_number
Новые параметры: ports
, password_new
Удалённые параметры: passwd
, passwd_new
, mp4_streaming
Новые параметры: modal
Удалённые параметры: receiver_email
, receiver_id
, send_notification
, refresh
, reload
, return_path