Домены (domain)

domain

Результат: список элементов.

Домены.

Уровень доступа: admin user.

Параметр	Значение
`id`	Id.
`domain`	Имя домена.
`account`	Клиент.
`pricelist`	Тариф.
`project`	Провайдер.
`processingmodule`	Модуль обработки.
`createdate`	Дата создания.
`expiredate`	Действует до.
`status_msg`	Описание текущего состояния.
`item_status`	Статус услуги. Может принимать значения: `1` — заказана; `2` — активна; `3` — остановлена; `4` — удалена; `5` — обрабатывается.
`cost`	Стоимость.

Информация о домене

Функция: domain.whois

Уровень доступа: admin user.

Используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Параметры:
- elid — уникальный идентификатор (элемент id из функции domain);
Результат: список параметров объекта.

Создание объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok;
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке.

Изменение объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok;
- elid — уникальный идентификатор (элемент id из функции domain);
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке.

Список параметров объекта или дополнительных параметров запроса:

Параметр	Значение
`whois_data`	Информация о домене. WHOIS информация о домене.

Зарегистрировать новый домен/домены

Функция: domain.order.register

Уровень доступа: user.

Включить

Функция: domain.resume

Уровень доступа: admin.

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделённых запятой и следующим за ней пробелом ", ". Уникальный идентификатор — элемент id из функции domain.

Результат: успешное выполнение операции или сообщение об ошибке.

Открытие услуги

Функция: domain.open

Уровень доступа: admin.

Используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Параметры:
- elid — уникальный идентификатор (элемент id из функции domain);
Результат: список параметров объекта.

Создание объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok;
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке.

Изменение объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok;
- elid — уникальный идентификатор (элемент id из функции domain);
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке.

Список параметров объекта или дополнительных параметров запроса:

Параметр	Значение
`processingmodule`	Модуль обработки, назначенный услуге.

Серверы имен

Функция: domain.ns

Уровень доступа: admin user.

Используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Параметры:
- elid — уникальный идентификатор (элемент id из функции domain);
Результат: список параметров объекта.

Создание объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok;
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке.

Изменение объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok;
- elid — уникальный идентификатор (элемент id из функции domain);
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке.

Список параметров объекта или дополнительных параметров запроса:

Параметр	Значение
`ns0`	NS. Формат записи "ns.example.com" или "ns.example.com/1.1.1.1" или "ns.example.com/1.1.1.1,2.2.2.2".
`ns1`	NS. Формат записи "ns.example.com" или "ns.example.com/1.1.1.1" или "ns.example.com/1.1.1.1,2.2.2.2".
`ns2`	NS. Формат записи "ns.example.com" или "ns.example.com/1.1.1.1" или "ns.example.com/1.1.1.1,2.2.2.2".
`ns3`	NS. Формат записи "ns.example.com" или "ns.example.com/1.1.1.1" или "ns.example.com/1.1.1.1,2.2.2.2".
`ns_additional`	Дополнительные NS. Формат записи "ns.example.com" или "ns.example.com/1.1.1.1" или "ns.example.com/1.1.1.1,2.2.2.2". Каждый дополнительный сервер имен указывается с новой строки.
`provider`	Провайдер серверов имён (регистратор домена).

Установить фильтр по клиенту

Функция: domain.setfilter

Уровень доступа: admin.

Имя файла

Функция: domain.doc

Результат: список элементов.

Документы.

Уровень доступа: admin user.

Параметр	Значение
`id`	Id.
`profile`	Контакт домена.
`doctype`	Тип документа.
`name`	Имя файла.
`size`	Размер.
`props`	Свойства.

Тип документа

Функция: domain.doc.edit

Уровень доступа: admin user.

Используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Параметры:
- plid — уникальный идентификатор родительского списка (элемент id из функции domain);
- elid — уникальный идентификатор (элемент id из функции domain.doc).
Результат: список параметров объекта.

Создание объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok;
- plid — уникальный идентификатор родительского списка (элемент id из функции domain);
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке.

Изменение объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok;
- plid — уникальный идентификатор родительского списка (элемент id из функции domain);
- elid — уникальный идентификатор (элемент id из функции domain.doc);
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке.

Список параметров объекта или дополнительных параметров запроса:

Параметр	Значение
`doctype`	Тип загружаемого документа.

Добавить документ

Функция: domain.doc.upload

Уровень доступа: admin user.

Используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Параметры:
- plid — уникальный идентификатор родительского списка (элемент id из функции domain);
- elid — уникальный идентификатор (элемент id из функции domain.doc).
Результат: список параметров объекта.

Создание объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok;
- plid — уникальный идентификатор родительского списка (элемент id из функции domain);
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке.

Изменение объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok;
- plid — уникальный идентификатор родительского списка (элемент id из функции domain);
- elid — уникальный идентификатор (элемент id из функции domain.doc);
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке.

Список параметров объекта или дополнительных параметров запроса:

Параметр	Значение
`doctype`	Тип загружаемого документа.

Удалить документ

Функция: domain.doc.delete

Уровень доступа: admin user.

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделённых запятой и следующим за ней пробелом ", ". Уникальный идентификатор — элемент id из функции domain.doc.

Результат: успешное выполнение операции или сообщение об ошибке.

Просмотреть выбранный файл

Функция: domain.doc.file

Уровень доступа: admin user.

Отправить файлы для подтверждения данных контакта домена

Функция: domain.doc.verify

Уровень доступа: admin user.

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделённых запятой и следующим за ней пробелом ", ". Уникальный идентификатор — элемент id из функции domain.doc.

Результат: успешное выполнение операции или сообщение об ошибке.

Выставить документу статус верификации

Функция: domain.doc.verified

Уровень доступа: admin user.

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделённых запятой и следующим за ней пробелом ", ". Уникальный идентификатор — элемент id из функции domain.doc.

Результат: успешное выполнение операции или сообщение об ошибке.

Скачать документ

Функция: domain.doc.download

Уровень доступа: admin user.

Войти в панель с правами пользователя

Функция: domain.su

Уровень доступа: admin.

Перенести домен/домены от другого регистратора

Функция: domain.order.transfer

Уровень доступа: user.

Редактирование услуги

Функция: domain.edit

Уровень доступа: admin user.

Используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Параметры:
- elid — уникальный идентификатор (элемент id из функции domain);
Результат: список параметров объекта.

Создание объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok;
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке.

Изменение объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok;
- elid — уникальный идентификатор (элемент id из функции domain);
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке.

Список параметров объекта или дополнительных параметров запроса:

Параметр	Значение
`processingmodule`	Модуль обработки.
`autoprolong`	Автоматическое продление. Выберите период, на который услуга будет продлеваться автоматически при окончании срока действия.
`createdate`	Дата заказа услуги.
`opendate`	Дата создания. Дата фактического начала действия услуги.
`expiredate`	Действует до. Срок действия услуги.
`scheduledclose`	Чтобы включить данную опцию используйте значение `on`. Запланировано удаление по окончанию оплаченного периода. Необязательный параметр.
`reboot`	Чтобы включить данную опцию используйте значение `on`. Необязательный параметр.
`note`	Комментарий к услуге, виден только сотрудникам провайдера.
`noexpense`	Чтобы включить данную опцию используйте значение `on`. Выберите опцию, если не нужно списывать или возвращать деньги за текущую операцию изменения ресурсов. Необязательный параметр.

Удалить выделенные услуги

Функция: domain.delete

Уровень доступа: admin user.

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделённых запятой и следующим за ней пробелом ", ". Уникальный идентификатор — элемент id из функции domain.

Результат: успешное выполнение операции или сообщение об ошибке.

Запросить данные и состояние домена у регистратора

Функция: domain.sync

Уровень доступа: admin.

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделённых запятой и следующим за ней пробелом ", ". Уникальный идентификатор — элемент id из функции domain.

Результат: успешное выполнение операции или сообщение об ошибке.

Установка фильтра

Функция: domain.filter

Уровень доступа: user