API.Monitorus Вы можете совершать операции по добавлению

API.Monitorus
Вы можете совершать операции по добавлению/редактированию заданий используя наше
API, без захода в интерфейс системы, путем отправки HTTP команд к нашему серверу.
Для быстрого перехода к разделу – нажмите CTRL и мышкой кликните на нужный раздел.
Оглавление
Формат входных данных............................................................................................................................. 2
Команды, доступные через API: ................................................................................................................. 2
Обязательные параметры при запросе: .................................................................................................... 3
Формат ответа:............................................................................................................................................. 3
Общие ошибки для всех команд: .............................................................................................................. 4
Полный перечень возможных ошибок: .................................................................................................... 4
Команды: ...................................................................................................................................................... 7
Команда user_stat.................................................................................................................................... 7
Команда user_folder_add ........................................................................................................................ 8
Команда user_folder_del ......................................................................................................................... 9
Команда user_folder_rename ...............................................................................................................10
Команда task_add ..................................................................................................................................12
Команда task_edit ..................................................................................................................................19
Команда task_start.................................................................................................................................20
Команда task_stop .................................................................................................................................22
Команда task_del ...................................................................................................................................23
Команда task_stat ..................................................................................................................................24
Команда task_info ..................................................................................................................................25
Команда task_list ...................................................................................................................................27
Команда task_folder_in .........................................................................................................................28
Команда task_folder_out .......................................................................................................................29
Команда task_folder_move ...................................................................................................................31
Формат входных данных
Все запросы должны уходить на https://api.monitorus.ru/index.php
Команды на осуществление операций передаются в виде стандартного запроса HTTP/1.0
методом POST. Параметры операции передаются в виде HTTP параметров. При этом
действуют следующие правила:




Значения полей передаются в кодировке utf-8.
Все требуемые поля должны присутствовать в запросе и должны содержать как
минимум один символ.
Значения полей не должны превышать допустимую длину.
Названия параметров HTTP-запроса должны в точности соответствовать названиям
полей с учётом регистра символов.
Команды, доступные через API:
Команды передаются в параметре action
Работа с пользователем:
user_stat – получение баланса пользователя, расход в день и остаток дней до истечения
баланса, количества активных заданий.
user_folder_add – добавление новой папки
user_folder_del – удаление папки
user_folder_rename – переименование папки
Работа с заданиями:
task_add – добавление нового задания на проверку
task_edit – редактирование задания
task_start – включение задания
task_stop – выключение задания
task_del – удаление задания
task_stat – получение статистики по заданию
task_info – получение информации по заданию: показателя Uptime для задания, текущего
статуса задания и др.
task_list – перечень всех заданий на вашем аккаунте
task_folder_in – поместить задание в папку
task_folder_out – удалить задание из папки
task_folder_move – переместить задание из одной папки в другую
Обязательные параметры при запросе:
В каждом запросе обязательно должны присутствовать:
user – Ваш логин
password – Ваш пароль
action – команда
В случае отсутствия одного (или нескольких) обязательных параметров, будет возвращена
ошибка с кодом 1 и значением «incomplete request»
Формат ответа:
Ответ поступает в виде JSON. Параметры ответа зависят от запрошенной команды и
приведены для каждой команды в описании.
В ответе на каждый запрос есть постоянные параметры, которые передаются всегда, в
независимости от результата. Это:
action – дублирует ту команду, которую Вы запросили
result – указывает на успешность выполнения операции. В случае выполненной операции
принимает значение success, а в случае ошибки - error
errors – массив с описанием допущенных ошибок. Передается только тогда, когда result
принимает значение error. Каждый элемент массива состоит из двух параметров:
code – результат выполнения операции. Принимает числовые значения.
descr – описание результата выполнения операции. Принимает текстовые значения,
латинский алфавит.
Например:
errors => [
{
code => '0',
descr => 'user not found'
},
{
code => '1',
descr => 'login incorrect'
},
{
code
descr
}
=> '2',
=> 'password incorrect'
]
Так же в ответе могут содержаться другие параметры в зависимости от запрошенной
команды. Подробнее смотрите в описании нужной команды.
Общие ошибки для всех команд:
В независимости от команды, могут быть следующие ошибки:
1
Значение code
Значение descr
incomplete request
2
3
wrong login or password
command not found
4
service unavailable
5
you blocked or API disabled for
you
Описание
При запросе переданы не все
необходимые параметры для
выполнения команды
Неверный логин или пароль
Команда, переданная в параметре
action, не найдена или не
существует или указана неверно /
вообще не передана.
Сервис временно недоступен.
Повторите попытку немного позже
Вы заблокированы или для вашего
логина не активирован доступ к
АПИ.
Полный перечень возможных ошибок:
В данной таблице содержится расшифровка всех возможных ошибок, а также указывается
при выполнении какой команды эта ошибка возникает
code
1
Значение descr
incomplete request
2
3
wrong login or
password
command not found
4
service unavailable
Описание
При запросе переданы не все
необходимые параметры для
выполнения команды
Неверный логин или пароль
Команда, переданная в
параметре action, не найдена или
не существует или указана
неверно / вообще нет этого
параметра
Сервис временно недоступен.
Команда
Все
Все
Все
Все
Повторите попытку немного
позже
Вы заблокированы или для
вашего логина не активирован
доступ к АПИ.
Папка с таким именем уже
существует у вас в аккаунте
Неверное имя папки (содержит
недопустимые символы или не
передано вообще)
5
you blocked or API
disabled for you
6
folder already exists
7
wrong folder name
8
folder not exists
Папки с таким именем не
существует на вашем аккаунте.
9
wrong folder name
10
wrong old folder
name
11
wrong new folder
name
12
new folder already
exists
required parameters
are not passed
Неверное имя папки (содержит
недопустимые символы или не
передано вообще)
Неверное имя папки (старое) –
содержит недопустимые
символы или не передано
вообще
Неверное имя папки (новое) – не
допустимые символы или не
передано вообще.
Папка с таким именем (новым)
уже существует у вас в аккаунте
Переданы не все обязательные
параметры для добавления /
редактирования задания
Передан неверный URL или IP
задания
Передано неверное имя для
задания
Не переданы контакты для
уведомлений
Переданный контакт для
уведомлений не активен или не
принадлежит вам или у вас еще
нет активных подтвержденных
контактов для уведомлений.
Передано больше, чем 5
контактов
Передан неверный реферер
13
14
incorrect value: data
15
incorrect value:
name
contacts are not
passed
contact is not active
or not your
16
17
18
more than 5 contacts
19
incorrect value:
referrer
incorrect value:
user_agent
incorrect value:
login_task
incorrect value:
password_task
20
21
22
Передан неверный юзер-агент
Передан неверный логин для
задания
Передан неверный пароль для
задания
Все
user_folder_add
user_folder_add
task_folder_in
task_folder_out
task_add
user_folder_del
user_folder_rename
task_folder_in
task_folder_out
user_folder_del
user_folder_rename
task_folder_move
user_folder_rename
task_folder_move
user_folder_rename
task_add
task_edit
task_add
task_edit
task_add
task_edit
task_add
task_edit
task_add
task_edit
task_add
task_edit
task_add
task_edit
task_add
task_edit
task_add
task_edit
task_add
task_edit
23
login and password
required
24
incorrect value: port
25
28
incorrect value:
search_text
incorrect value:
dns_site
incorrect value:
dns_data
dns_site required
29
dns_data required
30
data must be a url
31
value is not int or
bad value
32
task is not found
33
task is already work
34
task no answer
35
you have no money
36
37
38
task is already stop
task is already delete
incorrect value:
date_from
incorrect value:
date_to
task is not in this
folder
old folder not exists
26
27
39
40
41
Не передан логин или пароль. А
он нужен для данного типа
проверки.
Передан неверный порт
Передано неверное значение
параметра search_text
Передано неверное значение
поля dns_site
Передано неверное значение
поля dns_data
Не передано значение dns_site, а
оно необходимо для данного
типа проверки
Не передано значение dns_data, а
оно необходимо для данного
типа проверки
Для данного типа проверки в
параметре data должен быть
указан URL сайта, а не IP
В параметрах, в которых должно
быть значение в виде числа,
передано не число (не только
число) или один из параметров в
виде числа принимает неверные
значения.
Задание с указанным ID не
найдено на вашем аккаунте /
либо переданный task_id не
является числом.
Задание уже включено и
работает
Задание не ответило при
тестовой проверке и не может
быть включено
На вашем балансе недостаточно
средств
Задание уже выключено
Задание уже удалено
Неверно передана дата начала
выборки
Неверно передана дата
окончания выборки
Указанное задание не находится
в указанной вами папке.
Папки с таким именем не
task_add
task_edit
task_add
task_edit
task_add
task_edit
task_add
task_edit
task_add
task_edit
task_add
task_edit
task_add
task_edit
task_add
task_edit
task_add
task_edit
task_edit
task_start
task_stop
task_del
task_stat
task_info
task_folder_in
task_folder_out
task_folder_move
task_start
task_start
task_start
task_stop
task_del
task_stat
task_stat
task_folder_out
task_folder_move
42
new folder not exists
43
task is not edit
44
no balance
45
task already in this
folder
существует на вашем аккаунте
(старая).
Папки с таким именем не
существует на вашем аккаунте
(новая).
Тестовая проверка с указанными
параметрами не прошла, поэтому
задание НЕ отредактировано.
Нужно проверить правильность
указания данных или работу
проверяемого ресурса.
Не хватает средств на балансе,
поэтому задание было
отредактировано и выключено
Задание уже находится в этой
папке
task_folder_move
task_edit
task_edit
task_folder_in
Команды:
Команда user_stat
Данная команда позволяет получить информацию о пользователе: его текущий баланс,
количество активных заданий, расход в сутки и количество дней, оставшихся до
истечения баланса.
Запрос:
В запросе необходимо передать параметры:
Параметр
user
password
action
Значение
Ваш логин.
Минимальная длина 3
символа, максимальная 16.
Ваш пароль.
user_stat
Пример
login
H8989syhllsj
user_stat
Ответ:
Ответ (в виде JSON) содержит параметры:
Параметр
result
errors
Значение
Результат выполнения
операции. В случае удачи
принимает значение success.
В случае ошибки – error
Передает обнаруженные
Пример
success
[
{
Передается только при наличии
ошибок и result=error
action
user
balance
per_day
tasks
days
ошибки в виде массива в
случаи их наличия и
result=error
code
descr
},
{
code
descr
},
]
Команда, которая была
запрошена.
Логин пользователя
Баланс пользователя в
рублях.
Расход в сутки, в рублях.
Количество активных
заданий
Количество дней до
истечения баланса
user_stat
=> '1',
=> 'incomplete request'
=> '2',
=> 'wrong login or password'
login
156.1426
4.2654
187
34
Возможные ошибки:
При выполнении этой команды помимо стандартных общих ошибок других нет.
Команда user_folder_add
Данная команда позволяет создать папку для заданий (куда можно поместить то или иное
задание) для сортировки заданий и удобства их отображения и использования.
Запрос:
В запросе необходимо передать параметры:
Параметр
user
password
action
folder_name
Значение
Ваш логин.
Минимальная длина 3
символа, максимальная 16.
Ваш пароль.
user_folder_add
Название папки.
Минимум 3 символа,
максимум 30.
Может содержать латинские
и кириллические буквы в
любом регистре, цифры,
знаки @, точка, запятая,
дефис, нижнее
подчеркивание, пробел.
Только в UTF-8.
Пример
login
H8989syhllsj
user_folder_add
Моя папка
Ответ:
Ответ (в виде JSON) содержит параметры:
Параметр
result
errors
Передается только при наличии
ошибок и result=error
Значение
Результат выполнения
операции. В случае удачи
принимает значение success.
В случае ошибки – error
Передает обнаруженные
ошибки в виде массива в
случаи их наличия и
result=error
Команда, которая была
запрошена
ID созданной папки по базе
Monitorus
action
folder_id
Пример
success
[
{
code
descr
},
{
code
descr
},
]
=> '1',
=> 'incomplete request'
=> '2',
=> 'wrong login or password'
user_folder_add
1647
Возможные ошибки:
При выполнении этой команды помимо стандартных общих ошибок, возможны
следующие ошибки:
6
Значение code
Значение descr
folder already exists
7
wrong folder name
Описание
Папка с таким именем уже
существует у вас в аккаунте
Неверное имя папки (содержит
недопустимые символы или не
передано вообще)
Команда user_folder_del
Данная команда позволяет удалить ранее созданную папку.
Запрос:
В запросе необходимо передать параметры:
Параметр
user
password
action
folder_name
Значение
Ваш логин.
Минимальная длина 3
символа, максимальная 16.
Ваш пароль.
user_folder_del
Название папки.
Пример
login
H8989syhllsj
user_folder_del
Моя папка
Минимум 3 символа,
максимум 30.
Может содержать латинские
и кириллические буквы в
любом регистре, цифры,
знаки @, точка, запятая,
дефис, нижнее
подчеркивание, пробел.
Только в UTF-8.
Ответ:
Ответ (в виде JSON) содержит параметры:
Параметр
result
errors
Передается только при наличии
ошибок и result=error
Значение
Результат выполнения
операции. В случае удачи
принимает значение success.
В случае ошибки – error
Передает обнаруженные
ошибки в виде массива в
случаи их наличия и
result=error
Команда, которая была
запрошена
action
Пример
success
[
{
code
descr
},
{
code
descr
},
]
=> '1',
=> 'incomplete request'
=> '2',
=> 'wrong login or password'
user_folder_del
Возможные ошибки:
При выполнении этой команды помимо стандартных общих ошибок, возможны
следующие ошибки:
Значение code
8
Значение descr
folder not exists
9
wrong folder name
Описание
Папки с таким именем не
существует на вашем аккаунте.
Неверное имя папки (содержит
недопустимые символы или не
передано вообще)
Команда user_folder_rename
Данная команда позволяет переименовать ранее созданную папку.
Запрос:
В запросе необходимо передать параметры:
Параметр
user
password
action
folder_name_old
folder_name_new
Значение
Ваш логин.
Минимальная длина 3
символа, максимальная 16.
Ваш пароль.
user_folder_rename
Старое название папки.
Минимум 3 символа,
максимум 30.
Может содержать латинские
и кириллические буквы в
любом регистре, цифры,
знаки @, точка, запятая,
дефис, нижнее
подчеркивание, пробел.
Только в UTF-8.
Новое название папки.
Минимум 3 символа,
максимум 30.
Может содержать латинские
и кириллические буквы в
любом регистре, цифры,
знаки @, точка, запятая,
дефис, нижнее
подчеркивание, пробел.
Только в UTF-8.
Пример
login
H8989syhllsj
user_folder_rename
Моя папка
Моя новая папка
Ответ:
Ответ (в виде JSON) содержит параметры:
Параметр
result
errors
Передается только при наличии
ошибок и result=error
action
Возможные ошибки:
Значение
Результат выполнения
операции. В случае удачи
принимает значение success.
В случае ошибки – error
Передает обнаруженные
ошибки в виде массива в
случаи их наличия и
result=error
Команда, которая была
запрошена
Пример
success
[
{
code
descr
},
{
code
descr
},
]
=> '1',
=> 'incomplete request'
=> '2',
=> 'wrong login or password'
user_folder_rename
При выполнении этой команды помимо стандартных общих ошибок, возможны
следующие ошибки:
Значение code
8
Значение descr
folder not exists
10
wrong old folder name
11
wrong new folder name
12
new folder already exists
Описание
Папки с таким именем (старым) не
существует на вашем аккаунте.
Неверное имя папки (старое) –
содержит недопустимые символы
или не передано вообще
Неверное имя папки (новое) –
содержит недопустимые символы
или не передано вообще
Папка с таким именем (новым) уже
существует у вас в аккаунте
Команда task_add
Данная команда позволяет добавить новое задание на проверку.
Запрос:
В запросе необходимо передать параметры:
Параметр
user
password
action
task
data
Значение
Ваш логин.
Минимальная длина 3
символа, максимальная 16.
Ваш пароль.
task_add
Тип необходимой проверки,
в виде числа.
1 - HTTP (метод HEAD)
2 - HTTP (метод GET)
3 - HTTPS (метод HEAD)
4 - HTTPS (метод GET)
5 - FTP (без авторизации)
6 - FTP (с авторизацией:
анонимной или обычной)
7 - MySQL
8 - PostgreSQL
9 - POP3
10 - SMTP
11 - IMAP
12 - DNS
13 – Ping
URL сайта для проверки или
IP адрес. Только латиница
Пример
login
H8989syhllsj
task_add
1
monitorus.ru
name
port
Параметр необязателен
period
period_error
num_error
send_if_ok
(РФ и IDN домены
добавлять только в
punycode).
Без http:// в начале и
слэша на конце.
Имя задания. Разрешено
использовать 0-9, а-я, А-Я,
a-z, A-Z, пробел, точка,
тире, запятая, двоеточие,
слэш (/).Только в UTF-8.
Порт (при наличии).
Параметр необязателен –
если нет порта, то не
передавать его совсем или
передать 0
Период проверки, в минутах
(проверять каждые …
минут).
1 – Раз в минуту
2 – Раз в 2 минуты
3 – Раз в 3 минуты
4 – Раз в 4 минуты
5 – Раз в 5 минут
10 – Раз в 10 минут
15 – Раз в 15 минут
20 – Раз в 20 минут
30 – Раз в полчаса
60 – Раз в час
Период проверки во время
наличия ошибки, в минутах
(проверять каждые …
минут).
0 – точно так же как и period
1 – Раз в минуту
2 – Раз в 2 минуты
3 – Раз в 3 минуты
4 – Раз в 4 минуты
5 – Раз в 5 минут
10 – Раз в 10 минут
15 – Раз в 15 минут
20 – Раз в 20 минут
30 – Раз в полчаса
60 – Раз в час
Количество ошибок, после
которых слать уведомление
об ошибке:
2 – после 2 ошибок
3 – после 3 ошибок
5 – после 5 ошибок
Слать ли уведомление при
восстановлении работы:
Мой сайт
80
5
2
2
1
contacts
referer
Параметр необязателен
user_agent
Параметр необязателен
task_login
Параметр необязателен
0 – слать
1 – не слать
На какие контакты слать
уведомления при ошибке
или восстановлении.
Формируется как список из
ID контактов, через
запятую. Можно указать до
5 контактов. ID контактов
можно узнать в своем
аккаунте в списке контактов
для уведомления.
Реферер, с которым нужно
проверять задание.
Параметр необязателен –
если реферер не нужен, то
не передавать или передать
0
Разрешено использовать 0-9,
a-z, точки, тире, слэш (/),
нижнее подчеркивание (_).
Минимум 5 символов. Без
http:// в начале и слэша на
конце
Юзер-агент, с которым
нужно проверять задание.
Параметр необязателен –
если юзер-агент не нужен,
то не передавать или
передать 0.
Разрешено использовать 0-9,
a-z, A-Z, пробел, точка, слэш
(/), двоеточие, точка с
запятой, тире, нижнее
подчеркивание (_), знак +,
скобки (). Минимальное
количество символов – 10.
134,25,36
yandex.ru
Mozilla/5.0 (Windows; U;
Windows NT 5.1; ru;
rv:1.9.2.20) Gecko/20110803
Firefox/3.6.20
Если проверяемый ресурс
ivan
требует авторизации, то
нужно передать логин. Так
же логин нужно передать в
случае проверки FTP с
авторизацией. Для
остальных проверок поле не
обязательное, можно не
передавать или передать 0.
Разрешено использовать 0-9,
a-z, A-Z, точка, тире, нижнее
подчеркивание (_).
Минимальное количество
символов – 3
task_password
Параметр необязателен
search_text
Параметр необязателен
redirect
Параметр необязателен
rss
Параметр необязателен
ftp
Параметр необязателен
dns_type
Параметр необязателен
dns_site
Параметр необязателен
Если проверяемый ресурс
требует авторизации, то
нужно передать пароль. Так
же пароль нужно передать в
случае проверки FTP с
авторизацией. Для
остальных проверок поле не
обязательное, можно не
передавать или передать 0
Если выбрана проверка GET
и необходим поиск слова на
проверяемой странице, то
нужно передать это слово в
этом параметре. Если поиск
слова не нужен – можно не
передавать или передать 0
Разрешено использовать 0-9,
a-z, A-Z, пробел, точка,
запятая, тире. Минимальное
количество символов – 10
Если проверяемый ресурс
редиректит, то нужно
передать в этом параметре
значение 1. Если редиректа
нет, то 0 или не передавать
совсем.
Создать ли RSS ленту со
статусами задания?
0 или не передано – нет
1 – да
Если выбрана проверка FTP,
то в этом параметре нужно
передать метод соединения:
0 – пассивный
1 - активный
Если не FTP, то можно не
передавать или передать 0
Если выбрана проверка
DNS, то в этом параметре
нужно передать тип
проверки:
1 – SOA
2- A
3 – MX
4 – CNAME
Если не DNS, то можно не
передавать или передать 0
Если выбрана проверка
DNS, то в этом параметре
нужно передать DNS сервер,
на котором будем проверять
записи. Если не DNS, то
Hhgfygsgghd
My site
0
0
0
2
ns1.reg.ru
dns_data
Параметр необязателен
folder_name
Параметр необязателен
task_status
Параметр необязателен
можно не передавать или
передать 0. Разрешено
использовать 0-9, a-z, точки,
тире, слэш (/), нижнее
подчеркивание (_).
Минимум 5 символов. Без
http:// в начале и слэша на
конце
Если выбрана проверка
89.22.123.56
DNS, то в этом параметре
нужно передать запись,
которую мы будем
проверять на DNS сервере.
Если не DNS, то можно не
передавать или передать 0.
Разрешено использовать 0-9,
a-z, точки, тире, слэш (/),
нижнее подчеркивание (_).
Минимум 5 символов. Без
http:// и слэша на конце
Имя папки, в которую
Моя папка.
нужно поместить созданное
задание. Необязательно –
можно не передавать. Если
параметр передан и
указанная папка существует
– задание будет добавлено в
эту папку. Если указанной
папки не существует, то она
будет создана и задание
будет в нее помещено.
Может содержать латинские
и кириллические буквы в
любом регистре, цифры,
знаки @, точка, запятая,
дефис, нижнее
подчеркивание, пробел.
Минимум 3 символа,
максимум 30.
Только в UTF-8.
Если необходимо только
1
добавить задание, но не
включать его, то нужно
передать в этом параметре
значение 0.
Если задание нужно сразу
включить, то можно не
передавать этот параметр
или передать значение 1.
Ответ:
Ответ (в виде JSON) содержит параметры:
Параметр
result
errors
Передается только при наличии
ошибок и result=error
Значение
Результат выполнения
операции. В случае удачи
принимает значение success.
В случае ошибки – error
Передает обнаруженные
ошибки в виде массива в
случаи их наличия и
result=error
Команда, которая была
запрошена
Если задание добавлено
успешно, то в параметре
task_id будет содержаться
ID задания по базе
Monitorus, которое было
присвоено заданию
Если задание добавлено
успешно, то в параметре
task_status_result будет
содержаться статус
добавленного задания:
0 – задание добавлено, но не
включено по вашему
запросу
1 – задание добавлено и
включено
2 – задание добавлено, но не
включено, т.к. не хватает
средств.
3 – задание добавлено, но не
включено, т.к. задание не
ответило при тестовой
проверке, нужно проверить
данные задания или работу
проверяемого ресурса.
action
task_id
task_status_result
Пример
success
[
{
code
descr
},
{
code
descr
},
]
=> '1',
=> 'incomplete request'
=> '2',
=> 'wrong login or password'
task_add
31942
1
Возможные ошибки:
При выполнении этой команды помимо стандартных общих ошибок, возможны
следующие ошибки:
Значение code
13
Значение descr
required parameters are not
passed
Описание
Переданы не все обязательные
параметры для добавления задания
14
incorrect value: data
15
16
incorrect value: name
contacts are not passed
17
contact is not active or not your
18
19
20
21
more than 5 contacts
incorrect value: referrer
incorrect value: user_agent
incorrect value: login_task
22
incorrect value: password_task
23
login and password required
24
25
incorrect value: port
incorrect value: search_text
26
incorrect value: dns_site
27
incorrect value: dns_data
28
dns_site required
29
dns_data required
30
data must be a url
31
value is not int or bad value
7
wrong folder name
Передан неверный URL или IP
задания
Передано неверное имя для задания
Не переданы контакты для
уведомлений
Переданный контакт для
уведомлений не активен или не
принадлежит вам или у вас еще нет
активных подтвержденных
контактов для уведомлений.
Передано больше, чем 5 контактов
Передан неверный реферер
Передан неверный юзер-агент
Передан неверный логин для
задания
Передан неверный пароль для
задания
Не передан логин или пароль. А он
нужен для данного типа проверки.
Передан неверный порт
Передано неверное значение
параметра search_text
Передано неверное значение поля
dns_site
Передано неверное значение поля
dns_data
Не передано значение dns_site, а
оно необходимо для данного типа
проверки
Не передано значение dns_data, а
оно необходимо для данного типа
проверки
Для данного типа проверки в
параметре data должен быть указан
URL сайта, а не IP
В параметрах, в которых должно
быть значение в виде числа,
передано не число (не только
число) или один из параметров в
виде числа принимает неверные
значения.
Неверное имя папки (содержит
недопустимые символы или не
подходит по количеству символов)
Команда task_edit
Данная команда позволяет редактировать созданное ранее задание.
Запрос:
Редактированию не подлежит параметр task (тип проверки), data (данные – URL или IP
задания). Остальные данные можно менять.
В запросе необходимо передать параметры:
Параметр
user
password
action
task_id
Значение
Ваш логин.
Минимальная длина 3
символа, максимальная 16.
Ваш пароль.
task_edit
ID задания, которое нужно
отредактировать. ID по базе
Monitorus.
Пример
login
H8989syhllsj
task_edit
2658
Далее все передаваемые параметры точно такие же, как и в команде task_add, кроме task,
data, folder_name и task_status (эти параметры передавать не нужно). В передаваемых
параметрах должны содержаться новые данные задания. Передаваться должны все
параметры, а не только изменяемые. Т.е. если Вы меняете, допустим, только реферер, а
остальные параметры остаются такими же – то нужно передать абсолютно все параметры
задания, как будто создаете его заново.
Ответ:
Ответ (в виде JSON) содержит параметры:
Параметр
result
errors
Передается только при наличии
ошибок и result=error
action
task_id
Значение
Результат выполнения
операции. В случае удачи
принимает значение success.
В случае ошибки – error
Передает обнаруженные
ошибки в виде массива в
случаи их наличия и
result=error
Пример
success
[
{
code
descr
},
{
code
descr
},
]
=> '1',
=> 'incomplete request'
=> '2',
=> 'wrong login or password'
Команда, которая была
task_edit
запрошена
ID задания по базе Monitorus 2658
(то, по которому пришел
запрос и производится
операция)
Если задание
1
отредактировано успешно,
то в параметре
task_status_result будет
содержаться статус
отредактированного
задания:
0 – задание
отредактировано, но не
включено
1 – задание отредактировано
и включено
2 – задание
отредактировано, но не
включено, т.к. не хватает
средств.
task_status_result
Возможные ошибки:
При выполнении этой команды помимо стандартных общих ошибок, возможны ошибки,
которые соответствуют ошибкам при добавлении нового задания (см. команду task_add),
а так же:
Значение code
32
Значение descr
task is not found
43
task is not edit
44
no balance
Описание
Задание с указанным ID не найдено
на вашем аккаунте / переданный
task_id не является числом.
Тестовая проверка с указанными
параметрами не прошла, поэтому
задание НЕ отредактировано.
Нужно проверить правильность
указания данных или работу
проверяемого ресурса.
Не хватает средств на балансе,
поэтому задание было
отредактировано и выключено
Команда task_start
Данная команда включает проверки по указанному заданию
Запрос:
В запросе необходимо передать параметры:
Параметр
Значение
Пример
Ваш логин.
Минимальная длина 3
символа, максимальная 16.
Ваш пароль.
task_start
ID задания, которое нужно
включить. ID по базе
Monitorus.
user
password
action
task_id
login
H8989syhllsj
task_start
2658
Ответ:
Ответ (в виде JSON) содержит параметры:
Параметр
result
errors
Передается только при наличии
ошибок и result=error
Значение
Результат выполнения
операции. В случае удачи
принимает значение success.
В случае ошибки – error
Передает обнаруженные
ошибки в виде массива в
случаи их наличия и
result=error
Пример
success
[
{
code
descr
},
{
code
descr
},
]
=> '1',
=> 'incomplete request'
=> '2',
=> 'wrong login or password'
Команда, которая была
task_start
запрошена
ID задания по базе Monitorus 2658
(то, по которому пришел
запрос и производится
операция)
action
task_id
Возможные ошибки:
При выполнении этой команды помимо стандартных общих ошибок, возможны ошибки:
Значение code
32
Значение descr
task is not found
33
34
task is already work
task no answer
35
you have no money
Описание
Задание с указанным ID не найдено
на вашем аккаунте
Задание уже включено и работает
Задание не ответило при тестовой
проверке и не может быть
включено
На вашем балансе недостаточно
средств
Команда task_stop
Данная команда выключает проверки по указанному заданию
Запрос:
В запросе необходимо передать параметры:
Параметр
Значение
Ваш логин.
Минимальная длина 3
символа, максимальная 16.
Ваш пароль.
task_stop
ID задания, которое нужно
выключить. ID по базе
Monitorus.
user
password
action
task_id
Пример
login
H8989syhllsj
task_stop
2658
Ответ:
Ответ (в виде JSON) содержит параметры:
Параметр
result
errors
Передается только при наличии
ошибок и result=error
Значение
Результат выполнения
операции. В случае удачи
принимает значение success.
В случае ошибки – error
Передает обнаруженные
ошибки в виде массива в
случаи их наличия и
result=error
Пример
success
[
{
code
descr
},
{
code
descr
},
]
=> '1',
=> 'incomplete request'
=> '2',
=> 'wrong login or password'
Команда, которая была
task_stop
запрошена
ID задания по базе Monitorus 2658
(то, по которому пришел
запрос и производится
операция)
action
task_id
Возможные ошибки:
При выполнении этой команды помимо стандартных общих ошибок, возможны ошибки:
Значение code
32
Значение descr
task is not found
36
task is already stop
Описание
Задание с указанным ID не найдено
на вашем аккаунте
Задание уже выключено
Команда task_del
Данная команда удаляет указанное задание
Запрос:
В запросе необходимо передать параметры:
Параметр
Значение
Ваш логин.
Минимальная длина 3
символа, максимальная 16.
Ваш пароль.
task_del
ID задания, которое нужно
удалить. ID по базе
Monitorus.
user
password
action
task_id
Пример
login
H8989syhllsj
task_del
2658
Ответ:
Ответ (в виде JSON) содержит параметры:
Параметр
result
errors
Передается только при наличии
ошибок и result=error
Значение
Результат выполнения
операции. В случае удачи
принимает значение success.
В случае ошибки – error
Передает обнаруженные
ошибки в виде массива в
случаи их наличия и
result=error
Пример
success
[
{
code
descr
},
{
code
descr
},
]
=> '1',
=> 'incomplete request'
=> '2',
=> 'wrong login or password'
Команда, которая была
task_del
запрошена
ID задания по базе Monitorus 2658
(то, по которому пришел
запрос и производится
операция)
action
task_id
Возможные ошибки:
При выполнении этой команды помимо стандартных общих ошибок, возможны ошибки:
Значение code
32
Значение descr
task is not found
37
task is already delete
Описание
Задание с указанным ID не найдено
на вашем аккаунте
Задание уже удалено
Команда task_stat
Данная команда позволяет получить статистику ошибок в работе указанного задания
Запрос:
В запросе необходимо передать параметры:
Параметр
user
password
action
task_id
date_from
date_to
Значение
Ваш логин.
Минимальная длина 3
символа, максимальная 16.
Ваш пароль.
task_stat
ID задания, по которому
нужна статистика. ID по
базе Monitorus.
Дата, с которой нужна
статистика (c 00:00:00). В
формате YYYY-MM-DD
Дата, по которую нужна
статистика (по 23:59:59). В
формате YYYY-MM-DD
Пример
login
H8989syhllsj
task_stat
2658
2011-07-15
2011-07-25
Ответ:
Ответ (в виде JSON) содержит параметры:
Параметр
result
errors
Передается только при наличии
ошибок и result=error
action
task_id
stat
Значение
Результат выполнения
операции. В случае удачи
принимает значение success.
В случае ошибки – error
Передает обнаруженные
ошибки в виде массива в
случаи их наличия и
result=error
Команда, которая была
запрошена
ID задания по базе Monitorus
(то, по которому пришел
запрос и отдаются данные)
В случае удачного запроса массив, содержащий
статистику по выбранному
заданию. Элементы массива:
date_start – дата
возникновения ошибки
Пример
success
[
{
code
descr
},
{
code
descr
},
]
=> '1',
=> 'incomplete request'
=> '2',
=> 'wrong login or password'
task_stat
2658
{
date_start => '2011-07-15
15:56:20',
date_end => '2011-07-15
15:57:20',
time => '60',
date_end – дата окончания
ошибки (если ошибка не
устранена еще, то 0000-0000 00:00:00)
time – количество секунд, в
течение которых задание
было недоступно (если
ошибка еще не устранена, то
0)
code - код ошибки
Даты в формате YYYYMM-DD HH:MM:SS.
В случае отсутствия
статистики по заданию, в
параметре stat ничего не
будет передано, т.е. пусто
code => '0'
},
{
date_start => '2011-07-15
15:56:20',
date_end => '2011-07-15
15:57:20',
time => '60',
code => '0'
},
…
Возможные ошибки:
При выполнении этой команды помимо стандартных общих ошибок, возможны ошибки:
Значение code
32
Значение descr
task is not found
38
incorrect value: date_from
39
incorrect value: date_to
Описание
Задание с указанным ID не найдено
на вашем аккаунте
Неверно передана дата начала
выборки
Неверно передана дата окончания
выборки
Команда task_info
Данная команда позволяет получить информацию по заданию: показатель uptime для
указанного задания и статус задания.
Запрос:
В запросе необходимо передать параметры:
Параметр
user
password
action
task_id
Значение
Ваш логин.
Минимальная длина 3
символа, максимальная 16.
Ваш пароль.
task_info
ID задания, по которому
нужен uptime. ID по базе
Monitorus.
Пример
Login
H8989syhllsj
task_info
2658
Ответ:
Ответ (в виде JSON) содержит параметры:
Параметр
result
errors
Передается только при наличии
ошибок и result=error
Значение
Результат выполнения
операции. В случае удачи
принимает значение success.
В случае ошибки – error
Передает обнаруженные
ошибки в виде массива в
случаи их наличия и
result=error
Команда, которая была
запрошена
ID задания по базе Monitorus
(то, по которому пришел
запрос и отдаются данные)
Вид проверки (1 – HTTP, 2 –
HTTPS, … см. описание task
при добавлении задания)
В случае удачного запроса –
показатель uptime
В случае удачного запроса –
статус задания:
0 – задание выключено
1 – задание включено
2 – задание выключено, т.к.
не хватает средств.
В случае удачного запроса –
текущий код, полученный в
результате последней
проверки.
В случае удачного запроса –
дата последней проверки в
виде YYYY-MM-DD
HH:MM:SS
action
task_id
task
uptime
task_status
current_code
last_monitoring
Пример
success
[
{
code
descr
},
{
code
descr
},
]
=> '1',
=> 'incomplete request'
=> '2',
=> 'wrong login or password'
task_info
2658
1
99.75
1
200
2011-08-13 16:46:52
Возможные ошибки:
При выполнении этой команды помимо стандартных общих ошибок, возможны ошибки:
Значение code
32
Значение descr
task is not found
Описание
Задание с указанным ID не найдено
на вашем аккаунте
Команда task_list
Данная команда позволяет получить полный список заданий на Вашем аккаунте, их ID и
статус.
Запрос:
В запросе необходимо передать параметры:
Параметр
user
password
action
Значение
Ваш логин.
Минимальная длина 3
символа, максимальная 16.
Ваш пароль.
task_list
Пример
Login
H8989syhllsj
task_list
Ответ:
Ответ (в виде JSON) содержит параметры:
Параметр
result
errors
Передается только при наличии
ошибок и result=error
action
user
tasks
Значение
Результат выполнения
операции. В случае удачи
принимает значение success.
В случае ошибки – error
Передает обнаруженные
ошибки в виде массива в
случаи их наличия и
result=error
Команда, которая была
запрошена
Ваш логин
Список заданий в виде
массива, где
id – ID задания по базе
Мониторуса
task – вид проверки ( см.
описание task при
добавлении)
name – имя задания
data – URL или IP
task_status – статус задания:
0 – задание выключено
1 – задание включено
2 – задание выключено, т.к.
не хватает средств.
Имя задания приходит в
Пример
success
[
{
code
descr
},
{
code
descr
},
]
=> '1',
=> 'incomplete request'
=> '2',
=> 'wrong login or password'
task_list
login
{
id => ‘10’,
task => ‘1’,
name => ‘Мой сайт’,
data => ‘site.ru’,
task_status => ‘1’
},
{
id => ‘11’,
task => ‘1’,
name => ‘Мой сайт 2’,
data => ‘site2.ru’,
task_status => ‘0’
},
…
кодировке ISO если там
есть русские буквы !!!
Т.е. в виде:
\u0441\u0430\u0439 …
Возможные ошибки:
При выполнении этой команды возможны только стандартные ошибки:
Команда task_folder_in
Данная команда позволяет поместить задание в указанную папку.
Запрос:
В запросе необходимо передать параметры:
Параметр
user
password
action
task_id
folder_name
Значение
Ваш логин.
Минимальная длина 3
символа, максимальная 16.
Ваш пароль.
task_folder_in
ID задания, которое
добавляем в папку. ID по
базе Monitorus.
Название папки, в которую
нужно поместить задание.
Минимум 3 символа,
максимум 30.
Может содержать латинские
и кириллические буквы в
любом регистре, цифры,
знаки @, точка, запятая,
дефис, нижнее
подчеркивание, пробел.
Только в UTF-8.
Пример
Login
H8989syhllsj
task_folder_in
2658
Моя папка
Ответ:
Ответ (в виде JSON) содержит параметры:
Параметр
result
Значение
Результат выполнения
Пример
success
errors
Передается только при наличии
ошибок и result=error
операции. В случае удачи
принимает значение success.
В случае ошибки – error
Передает обнаруженные
ошибки в виде массива в
случаи их наличия и
result=error
[
{
code
descr
},
{
code
descr
},
]
=> '1',
=> 'incomplete request'
=> '2',
=> 'wrong login or password'
Команда, которая была
task_folder_in
запрошена
ID задания по базе Monitorus 2658
(то, по которому пришел
запрос)
action
task_id
Возможные ошибки:
При выполнении этой команды помимо стандартных общих ошибок, возможны ошибки:
Значение code
32
Значение descr
task is not found
7
wrong folder name
8
folder not exists
45
task already in this folder
Описание
Задание с указанным ID не найдено
на вашем аккаунте
Неверное имя папки – не
допустимые символы или не
передано вообще.
Папки с таким именем не
существует на вашем аккаунте.
Задание уже находится в этой папке
Команда task_folder_out
Данная команда позволяет убрать задание из указанной папки
Запрос:
В запросе необходимо передать параметры:
Параметр
user
password
action
task_id
Значение
Ваш логин.
Минимальная длина 3
символа, максимальная 16.
Ваш пароль.
task_folder_out
ID задания, которое убираем
из папки. ID по базе
Пример
Login
H8989syhllsj
task_folder_out
2658
Monitorus.
Название папки, из которой
нужно убрать задание.
Минимум 3 символа,
максимум 30.
Может содержать латинские
и кириллические буквы в
любом регистре, цифры,
знаки @, точка, запятая,
дефис, нижнее
подчеркивание, пробел.
Только в UTF-8.
folder_name
Моя папка
Ответ:
Ответ (в виде JSON) содержит параметры:
Параметр
result
errors
Передается только при наличии
ошибок и result=error
Значение
Результат выполнения
операции. В случае удачи
принимает значение success.
В случае ошибки – error
Передает обнаруженные
ошибки в виде массива в
случаи их наличия и
result=error
Пример
success
[
{
code
descr
},
{
code
descr
},
]
=> '1',
=> 'incomplete request'
=> '2',
=> 'wrong login or password'
Команда, которая была
task_folder_out
запрошена
ID задания по базе Monitorus 2658
(то, по которому пришел
запрос)
action
task_id
Возможные ошибки:
При выполнении этой команды помимо стандартных общих ошибок, возможны ошибки:
Значение code
32
Значение descr
task is not found
7
wrong folder name
8
folder not exists
40
task is not in this folder
Описание
Задание с указанным ID не найдено
на вашем аккаунте
Неверное имя папки – не
допустимые символы или не
передано вообще.
Папки с таким именем не
существует на вашем аккаунте.
Указанное задание не находится в
указанной вами папке.
Команда task_folder_move
Данная команда позволяет переместить задание из одной папки в другую
Запрос:
В запросе необходимо передать параметры:
Параметр
user
password
action
task_id
folder_name_old
folder_name_new
Значение
Ваш логин.
Минимальная длина 3
символа, максимальная 16.
Ваш пароль.
task_folder_move
ID задания, которое
переносим. ID по базе
Monitorus.
Папка откуда переносим.
Минимум 3 символа,
максимум 30.
Может содержать латинские
и кириллические буквы в
любом регистре, цифры,
знаки @, точка, запятая,
дефис, нижнее
подчеркивание, пробел.
Только в UTF-8.
Папка куда переносим.
Минимум 3 символа,
максимум 30.
Может содержать латинские
и кириллические буквы в
любом регистре, цифры,
знаки @, точка, запятая,
дефис, нижнее
подчеркивание, пробел.
Только в UTF-8.
Пример
Login
H8989syhllsj
task_folder_move
2658
Моя папка
Моя новая папка
Ответ:
Ответ (в виде JSON) содержит параметры:
Параметр
result
errors
Передается только при наличии
ошибок и result=error
Значение
Результат выполнения
операции. В случае удачи
принимает значение success.
В случае ошибки – error
Передает обнаруженные
ошибки в виде массива в
случаи их наличия и
result=error
Пример
success
[
{
code
descr
},
{
=> '1',
=> 'incomplete request'
code
descr
},
]
=> '2',
=> 'wrong login or password'
Команда, которая была
task_folder_move
запрошена
ID задания по базе Monitorus 2658
(то, по которому пришел
запрос)
action
task_id
Возможные ошибки:
При выполнении этой команды помимо стандартных общих ошибок, возможны ошибки:
Значение code
32
Значение descr
task is not found
40
task is not in this folder
10
wrong old folder name
11
wrong new folder name
41
old folder not exists
42
new folder not exists
Описание
Задание с указанным ID не найдено
на вашем аккаунте
Указанное задание не находится в
указанной вами папке (старой).
Неверное имя папки (старое) – не
допустимые символы или не
передано вообще.
Неверное имя папки (новое) – не
допустимые символы или не
передано вообще.
Папки с таким именем не
существует на вашем аккаунте
(старая).
Папки с таким именем не
существует на вашем аккаунте
(новая).