IPmanager API/Administrator

Материал из ISPWiki

(Перенаправлено с IPmanager API)
Перейти к: навигация, поиск

Содержание

См. также


Администратор

Главное

Пользователи

Управление пользователями

Функция: user

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

  • name - Логин.
  • owner - Владелец.
  • level - Уровень.


Создание. Изменение. Параметры пользователя

Функция: user.edit

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

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

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

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

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

  • name - Логин.
  • level - Уровень доступа.
  • passwd - Пароль.
  • confirm - Подтверждение.


Удалить пользователей

Функция: user.delete

Параметры:

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

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


Блоки IP-адресов пользователя

Функция: user.perm

Параметры:

  • elid - уникальный идентификатор (элемент "name" из функции "user").

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

  • key - Уникальный идентификатор элемента списка.
  • type - Тип блока.
  • range - Блок IP-адресов.


Создание. Изменение. Параметры блока IP-адресов

Функция: user.perm.edit

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

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

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент "name" из функции "user").
    • elid - уникальный идентификатор (элемент "key" из функции "user.perm")
  • Результат: список параметров объекта

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

  • Параметры:
    • sok- значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент "name" из функции "user").
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

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

  • Параметры:
    • sok- значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент "name" из функции "user").
    • elid - уникальный идентификатор (элемент "key" из функции "user.perm")
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

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

  • type - Тип блока.
  • range - Блок IP-адресов.


Освободить блоки IP-адресов

Функция: user.perm.delete

Параметры:

  • plid - уникальный идентификатор родительского списка (элемент "name" из функции "user").
  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "key" из функции "user.perm".

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


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

Функция: user.su


Сети

Управление сетями

Функция: net

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

  • name - Сеть.
  • file - Файл.
  • used - Использовано адресов. Атрибуты :
    • used - Использованное количество.
    • limit - Максимально возможное значение.


Создание. Изменение. Параметры сети

Функция: net.edit

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

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

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

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

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

  • family - Тип сети.
    При выбранном значении ip4 разрешается использовать параметры: 'mask' и запрещается использовать параметры: 'prefix'
При выбранном значении ip6 разрешается использовать параметры: 'prefix' и запрещается использовать параметры: 'mask'
  • name - Сеть.
  • gateway - Адрес шлюза.
  • mask - Маска сети.
  • prefix - Длина префикса.
  • file - Файл.
  • genfile - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
    Активный параметр разрешает следующие параметры: 'email','ns'
  • email - Email администратора зоны.
  • ns - Сервера имен.


Удалить сети

Функция: net.delete

Параметры:

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

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


Реверсные записи (PTR)

Функция: net.addr

Параметры:

  • elid - уникальный идентификатор (элемент "name" из функции "net").

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

  • ip - IP-адрес.
  • name - Доменное имя.
  • owner - Владелец.
  • type - Тип.
  • note - Примечание.


Создание. Изменение. Настройка реверсной записи (PTR)

Функция: net.addr.edit

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

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

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент "name" из функции "net").
    • elid - уникальный идентификатор (элемент "ip" из функции "net.addr")
  • Результат: список параметров объекта

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

  • Параметры:
    • sok- значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент "name" из функции "net").
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

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

  • Параметры:
    • sok- значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент "name" из функции "net").
    • elid - уникальный идентификатор (элемент "ip" из функции "net.addr")
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

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

  • ip - IP-адрес.
  • name - Доменное имя.
  • type - Тип.
  • owner - Владелец.
  • note - Примечание.


Освободить IP-адреса

Функция: net.addr.delete

Параметры:

  • plid - уникальный идентификатор родительского списка (элемент "name" из функции "net").
  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "ip" из функции "net.addr".

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


Типы IP-адресов

Типы IP-адресов

Функция: iptype

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

  • name - Тип.


Создание. Изменение. Создать новый тип

Функция: iptype.edit

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

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

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

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

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

  • name - Вводимое здесь значение будет использовано как название нового типа IP-адресов.


Удалить типы

Функция: iptype.delete

Параметры:

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

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


Статистика

Использование IP

Использование IP-адресов

Функция: ipusagestat

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

  • user - Пользователь.
  • type - Тип IP-адреса.
  • count - Использовано адресов.


Распределение IP

Распределение IP-адресов

Функция: ipblockstat

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

  • range - Диапазон.
  • who - Назначение.
  • usage - Использование. Атрибуты :
    • used - Использованное количество.
    • limit - Максимально возможное значение.


Текущая активность

Текущая активность

Функция: session

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

  • id - Номер сессии.
  • name - Пользователь.
  • lv_12 - .
  • lv_11 - .
  • lv_10 - .
  • lv_7 - Администратор.
  • lv_6 - Реселлер.
  • lv_5 - Пользователь.
  • lv_4 - Пользователь с доступом к shell.
  • lv_3 - FTP аккаунт.
  • lv_2 - Почтовый ящик.
  • ip - IP-адрес.
  • idle - Ожидание.


Завершить выбранные сеансы

Функция: session.delete

Параметры:

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

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


Войти в панель с такими же правами

Функция: session.su


Журнал операций

Журнал операций

Функция: journal

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

  • id - Уникальный идентификатор элемента списка.
  • time - Время.
  • user - Пользователь.
  • ip - Удалённый IP-адрес.
  • funcname - Функция.


Просмотр журнала. Просмотр. Изменение

Функция: journal.edit

Данная функция одновременно используется для просмотра и изменения параметров объекта

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

  • Параметры:
    • elid - уникальный идентификатор (элемент "id" из функции "journal")
  • Результат: список параметров

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

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

  • time - Время.
  • user - Пользователь.
  • ip - Удалённый IP-адрес.
  • funcname - Функция.
  • params - Параметры.


Настройки

Параметры IPmanager

Параметры IPmanager. Просмотр. Изменение

Функция: param

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

Изменение данных:

Список параметров или дополнительных параметров запроса (см.выше):

  • freename - Доменное имя для свободных адресов.
  • viewname - Пространство имён DNS .
  • pingip - Проверять занятость IP адреса с помощью ping. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)


Настройка бренда

Настройка бренда. Просмотр. Изменение

Функция: brand

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

Изменение данных:

Список параметров или дополнительных параметров запроса (см.выше):

  • site - Ссылка на логотипе (http://my-hosting-company.com).
  • project - Ссылка на логотипе (http://my-hosting-company.com).
  • mainlogo - .
  • loginlogo - .
  • favicon - .
  • reset - Сбросить все настройки бренда. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • h - Тон.
  • s - Насыщенность.
  • l - Яркость.
  • headinclude - Дополнение к HEAD.
  • customstring - Указать свою подпись. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
    Активный параметр разрешает следующие параметры: 'customstringvalue'
Активный параметр запрещает следующие параметры: 'companyname','foundationyear'
  • customstringvalue - Копирайт.
  • companyname - Наименование компании.
  • foundationyear - Год основания.
  • companyurl - URL сайта компании.
  • noaddlang - Не добавлять к URL локализацию. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)


Плагины

Плагины

Функция: plugin

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

  • name - Имя плагина.
  • desc - Краткое описание.
  • version - Версия.
  • bad - Описание плагина содержит ошибки. Он не работает..
  • newver - .


Коллекция плагинов

Функция: plugin.collection

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

  • name - Имя плагина.
  • desc - Описание.
  • version - Версия.
  • author - Автор.


Установка плагина. Просмотр. Изменение

Функция: plugin.install

Данная функция одновременно используется для просмотра и изменения параметров объекта

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

  • Параметры:
    • elid - уникальный идентификатор (элемент "name" из функции "plugin.collection")
  • Результат: список параметров

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

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

  • agree - Я полностью осознаю последствия своих действий. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)


Плагин. Просмотр. Изменение

Функция: plugin.info

Данная функция одновременно используется для просмотра и изменения параметров объекта

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

  • Параметры:
    • elid - уникальный идентификатор (элемент "name" из функции "plugin.collection")
  • Результат: список параметров

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

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

  • description - Подробное описание.
  • interpretator - Язык программирования.
  • require - Необходимые модули.
  • author - Автор.
  • contact - Контакты.


Плагин. Просмотр. Изменение

Функция: plugin.info

Данная функция одновременно используется для просмотра и изменения параметров объекта

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

  • Параметры:
    • elid - уникальный идентификатор (элемент "name" из функции "plugin")
  • Результат: список параметров

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

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

  • description - Подробное описание.
  • interpretator - Язык программирования.
  • require - Необходимые модули.
  • author - Автор.
  • contact - Контакты.


Обновление плагинов

Функция: plugin.update


'

Функция: plugin.delete

Параметры:

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

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


Источники расширений

Функция: plugin.source

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

  • url - URL источника.


Создание. Изменение. Источник расширений

Функция: plugin.source.edit

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

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

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

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

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

  • url - URL источника.


Удалить источник

Функция: plugin.source.delete

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "url" из функции "plugin.source".

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


Обновить данные из источника

Функция: plugin.source.refresh

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "url" из функции "plugin.source".

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


Доступ к модулям

Доступ к модулям

Функция: access

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

  • name - Имя функции.
  • ftitle - Название модуля.
  • lv_12 - Модуль доступен на уровне администратора.
  • lv_11 - Модуль доступен на уровне реселлера.
  • lv_10 - Модуль доступен на уровне пользователя.
  • lv_7 - Модуль доступен на уровне администратора панели управления.
  • lv_6 - Модуль доступен на уровне реселлера.
  • lv_5 - Модуль доступен на уровне пользователя панели управления.
  • lv_4 - Модуль доступен на уровне пользователя с доступом к shell.
  • lv_3 - Модуль доступен на уровне FTP аккаунта.
  • lv_2 - Модуль доступен на уровне почтового пользователя.
  • status - Статус.


Доступ к модулю . Просмотр. Изменение

Функция: access.edit

Данная функция одновременно используется для просмотра и изменения параметров объекта

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

  • Параметры:
    • elid - уникальный идентификатор (элемент "name" из функции "access")
  • Результат: список параметров

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

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

  • name - Название модуля.
  • ftype - Тип доступа.

Возможные значения :

    • allow - Разрешён всем
    • deny - Запрещён всем
    • allow_partial - Разрешён выборочно
    • deny_partial - Запрещён выборочно
При выбранном значении allow_partial разрешается использовать параметры: 'userlist'
При выбранном значении deny_partial разрешается использовать параметры: 'userlist'
  • userlist - Список пользователей. (Одно или несколько значений, разделенных пробелом)


Настройки панели

Настройки панели. Просмотр. Изменение

Функция: usrparam

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

Изменение данных:

Список параметров или дополнительных параметров запроса (см.выше):

  • name - Имя пользователя.
  • email - E-mail для уведомлений.
  • email - E-mail для уведомлений. Параметр зависим от возможности billmgr.
  • changed - Тема.
  • theme - Тема.
  • lang - Язык.
  • timezone - Временная зона.
  • passwd - Пароль.
  • confirm - Подтверждение.
  • atype - Доступ к панели управления.
    При выбранном значении atany запрещается использовать параметры: 'addr'
  • addr - Список IP-адресов. (Одно или несколько значений, разделенных пробелом)
  • startpage - Стартовая страница.
  • rows - Строк на странице.
  • recordlimit - Количество записей.
  • buttonview - Вид кнопок.
  • ticketsound - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • ticketnoconfirm - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • useavatar - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
    Активный параметр разрешает следующие параметры: 'avatardfield','avatarfield','avatarview'
  • filename - .


Справка

Лицензия

Лицензия. Просмотр. Изменение

Функция: softinfo

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

Изменение данных:

Список параметров или дополнительных параметров запроса (см.выше):

  • os - Операционная система.
  • mgrver - Текущая версия.
  • mgrbuild - Дата компиляции.
  • licid - ID лицензии.
  • licip - IP лицензии.
  • licname - Имя лицензии.
  • licdate - Действует до.


Обновления

Установленные обновления

Функция: updatelist

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

  • id - Уникальный идентификатор элемента списка.
  • version - Версия.
  • release - Дата выпуска.
  • lines - Количество изменений.
  • backup - Дата резервной копии.


Список изменений версии

Функция: updatelist.changelog

Параметры:

  • elid - уникальный идентификатор (элемент "id" из функции "updatelist").

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

  • id - Уникальный идентификатор элемента списка.
  • description - Описание изменения.
  • isp1 - ISPmanager Lite.
  • isp2 - ISPmanager Pro.
  • isp3 - ISPmanager Cluster.
  • bill1 - BILLmanager Standard.
  • bill2 - BILLmanager Advanced.
  • bill3 - BILLmanager Corparate.
  • changetype - Тип изменения.


Откатить версию панели до . Просмотр. Изменение

Функция: updatelist.restore

Данная функция одновременно используется для просмотра и изменения параметров объекта

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

  • Параметры:
    • elid - уникальный идентификатор (элемент "id" из функции "updatelist")
  • Результат: список параметров

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

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


Настроить параметры обновления. Просмотр. Изменение

Функция: updatelist.settings

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

Изменение данных:

Список параметров или дополнительных параметров запроса (см.выше):

  • os - Операционная система.
  • mgrver - Текущая версия.
  • mgrbuild - Дата компиляции.
  • vertype - Тип версии.
  • srvver - Последняя версия.
  • mirror - Зеркало.
  • autoupdate - Автоматическое обновление. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)


Запустить обновление панели управления

Функция: updatelist.updatenow


Запрос улучшений

Запрос улучшений

Функция: wishlist

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

  • id - Код задачи.
  • name - Аннотация.
  • created - Дата создания.
  • vote - Голоса.
  • jobeval - Трудоемкость.
  • prio - Приоритет.
  • status - Состояние.


Создание. Изменение. Запрос

Функция: wishlist.edit

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

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

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

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

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

  • name - Аннотация.
  • desc - Описание.
  • myvote - Доступно голосов.
  • vote - Добавить мой голос.


Голосовать

Функция: wishlist.vote

  • myvote - Доступно голосов.
  • vote - Добавить мои голоса (за каждое улучшение).


Перечитать список улучшений

Функция: wishlist.refresh


Журнал ошибок

Журнал ошибок

Функция: errorjournal

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

  • date - Дата события.
  • funcname - Функция.
  • lv_12 - .
  • lv_11 - .
  • lv_10 - .
  • lv_7 - Администратор.
  • lv_6 - Реселлер.
  • lv_5 - Пользователь.
  • lv_4 - Пользователь с доступом к shell.
  • lv_3 - FTP аккаунт.
  • lv_2 - Почтовый ящик.
  • user - Пользователь.
  • status - Состояние.


Настройка журналирования. Просмотр. Изменение

Функция: errorjournal.settings

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

Изменение данных:

Список параметров или дополнительных параметров запроса (см.выше):

  • level - Уровень.


Ошибка от . Просмотр. Изменение

Функция: errorjournal.edit

Данная функция одновременно используется для просмотра и изменения параметров объекта

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

  • Параметры:
    • elid - уникальный идентификатор (элемент "date" из функции "errorjournal")
  • Результат: список параметров

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

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

  • email - E-Mail.
  • drop - Удалить отчет после отправки. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • data - .


Удалить выбранные отчеты

Функция: errorjournal.delete

Параметры:

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

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



  • Список активных возможностей можно получить через API-функцию "featurelist"
Была ли эта информация полезной? Да | Нет
Личные инструменты