Добавление задачи

Адрес для отправки запросов

Запросы должны отправляться методом GET или POST к следующему адресу:

Список параметров запроса

api_key

Обязательный параметр: да.
Значение: ваш уникальный ключ API, который можно найти в личном кабинете в разделе «Настройки профиля».
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&api_key=6e59663b2ce62ac378be24bc30f48b95946&[другие параметры]

tip

Обязательный параметр: нет.
Значение по умолчанию: http (это соответствует проверке HTTP (HEAD)).
Значение: тип проверки, возможными вариантами которого являются: http, http_get, http_post, https, https_get, https_post, ping.
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&tip=http_get&[другие параметры]

url

Обязательный параметр: да.
Значение: адрес или IP проверяемого сервиса.
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&url=ping-admin.com%2Ffree_test%2F&[другие параметры]

hosts_ip

Обязательный параметр: нет.
Значение: IP (IPv4) проверяемого сайта, к которому будет идти обращение вне зависимости от того, что прописано для адреса сайта в DNS.
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&hosts_ip=1.2.3.4&[другие параметры]

nazv

Обязательный параметр: нет.
Значение: название задачи, которое выводится в личном кабинете и уведомлениях об ошибках вместо (или вместе) с URL; текст не более 255 символов в кодировке Windows-1251.
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&nazv=%F2%E5%F1%F2123&[другие параметры]

period

Обязательный параметр: нет.
Значение по умолчанию: 5.
Значение: периодичность проверки, возможными значениями которой являются: 1 — каждую минуту; 2 — раз в 2 минуты; 3; 4; 5; 6; 10; 15; 20; 30; 60 — раз в час.
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&period=3&[другие параметры]

period_error

Обязательный параметр: нет.
Значение по умолчанию: 0.
Значение: периодичность проверки во время ошибки, возможными значениями которой являются: 0 —периодичность такая же, как в параметре «period»; 1 — каждую минуту; 2 — раз в 2 минуты; 3; 4; 5; 6; 10; 15; 20; 30; 60 — раз в час.
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&period_error=2&[другие параметры]

txt

Обязательный параметр: нет.
Значение: текст, который нужно искать в коде страницы при проверке сайта методом GET или POST (текст может быть только из ASCII-символов — латинские буквы, цифры и некоторые специальные символы).
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&txt=search_text_12345&[другие параметры]

httpcode_from

Обязательный параметр: нет.
Значение: HTTP-код ответа (начало допустимого диапазона).
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&httpcode_from=200&[другие параметры]

httpcode_to

Обязательный параметр: нет.
Значение: HTTP-код ответа (конец допустимого диапазона).
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&size_to=399&[другие параметры]

size_from

Обязательный параметр: нет.
Значение: минимальный ожидаемый размер проверяемой страницы в байтах.
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&size_from=1000&[другие параметры]

size_to

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

https://ping-admin.com/?a=api&sa=new_task&size_to=2000&[другие параметры]

sb

Обязательный параметр: нет.
Значение по умолчанию: 0.
Значение: проверять ли сайт на вирусы: 0 — не проверять, 1 — проверять; актуально только для проверок с типами HTTP, HTTPS.
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&sb=1&[другие параметры]

rk

Обязательный параметр: нет.
Значение по умолчанию: 0.
Значение: проверять ли сайт на наличие базах Роскомнадзора, Spamhaus и других: 0 — не проверять, 1 — проверять; актуально только для проверок с типами HTTP, HTTPS, Ping.
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&rk=1&[другие параметры]

rk_ip

Обязательный параметр: нет.
Значение по умолчанию: 0.
Значение: 0 — выполнять все проверки по всем базам; 1 — не проверять наличие IP в базе Роскомнадзора (РКН); 2 — не проверять наличие IP в РКН и не проверять по Spamhaus и др.; 3 — не проверять по Spamhaus и др.; 11 — не проверять наличие IP и отдельных страниц сайта в РКН; 12 — не проверять наличие IP и отдельных страниц сайта в РКН и не проверять по Spamhaus и др. Значение в данном параметре актуально только, если в параметре «rk» указано 1.
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&rk_ip=1&[другие параметры]

whois

Обязательный параметр: нет.
Значение по умолчанию: 0.
Значение: при значении 1 будет выполняться проверка изменений в WHOIS.
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&whois=1&[другие параметры]

oshib

Обязательный параметр: нет.
Значение по умолчанию: 1.
Значение: при какой подряд ошибке отправлять уведомление (0 — сразу; 1 — при второй подряд ошибке; 2 — при третьей; 4 — при пятой; 9 — при десятой подряд ошибке).
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&oshib=0&[другие параметры]

uveddva

Обязательный параметр: нет.
Значение по умолчанию: 0.
Значение: отправлять ли уведомления об ошибке повторно (0 — не отправлять; 60 — только 1 раз через 1 час; 120 — только 1 раз через 2 часа; 180; 240; 300; 360; 420; 480; 540; 720; 1080; 1440 — только 1 раз через 24 часа; 601 — каждый час; 1201 — каждые 2 часа; 1801; 2401; 3001; 3601; 4201; 4801; 5401; 7201; 10801; 14401 — каждые 24 часа).
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&uveddva=0&[другие параметры]

test_redirect

Обязательный параметр: нет.
Значение по умолчанию: 0.
Значение: если проверяемый адрес производит редирект, следовать ли по редиректу: 0 — не следовать, 1 — следовать.
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&test_redirect=1&[другие параметры]

test_https

Обязательный параметр: нет.
Значение по умолчанию: 0.
Значение: при значении 1 проверять SSL-сертификат, а именно официальность центра, который выдал сертификат, дату его действия, соответствие адреса сайта и адреса, для которого выдан сертификат и другие параметры.
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&test_https=1&[другие параметры]

cert

Обязательный параметр: нет.
Значение по умолчанию: 0.
Значение: при значении 1 присылать уведомления на адреса электронной почты, указанные в настройках задачи, за 30, 7 и 3 дня до окончания срока действия SSL-сертификата, а также уведомлять, если SSL-сертификат будет отозван ранее. Данная услуга позволяет не забыть обновить SSL-сертификат, когда срок его действия будет походить к концу (услуга платная).
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&cert=1&[другие параметры]

ssl_version

Обязательный параметр: нет.
Значение по умолчанию: 1.
Значение: какой протокол использовать для проверок сайтов с SSL-сертификатами: 1 — использовать TLS; 0 — использовать SSLv3.
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&ssl_version=0&[другие параметры]

nerab

Обязательный параметр: нет.
Значение по умолчанию: 0.
Значение: нужно обязательно указать 1, если добавляется сервис, неработающий в момент добавления задачи.
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&nerab=1&[другие параметры]

mails

Обязательный параметр: нет.
Значение: адреса электронной почты, указанные в разделе «Контакты для уведомлений» личного кабинета, через запятую или точку с запятой.
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&mails=test1%40site.ru,test2%40site.ru&[другие параметры]

phones

Обязательный параметр: нет.
Значение: номера телефонов для SMS, указанные в разделе «Контакты для уведомлений» личного кабинета, через запятую или точку с запятой (только цифры, в международном формате [код страны][код города или сети][номер телефона].
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&phones=79991112233,38060000000&[другие параметры]

gphones

Обязательный параметр: нет.
Значение: номера телефонов для звонков, указанные в разделе «Контакты для уведомлений» личного кабинета, через запятую или точку с запятой (только цифры, в международном формате [код страны][код города или сети][номер телефона].
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&gphones=14621112233,79991112233&[другие параметры]

ims

Обязательный параметр: нет.
Значение: идентификаторы для API контактов в Telegram, ICQ, Skype или Jabber, указанные в личном кабинете в разделе «Контакты для уведомлений / Telegram, ICQ, Skype, Jabber / Изменить у выбранного контакта», через запятую или точку с запятой.
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&ims=12345,jabber%40site.ru&[другие параметры]

https

Обязательный параметр: нет.
Значение: адреса для HTTP-уведомлений, указанные в разделе «Контакты для уведомлений» личного кабинета, через запятую или точку с запятой.
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&https=http%3A%2F%2Fsite.ru%2Fscript.php&[другие параметры]

graph

Обязательный параметр: нет.
Значение по умолчанию: 0.
Значение: строить ли графики с временем ответа сайта (используется только для проверок с типами: http, http_get, http_post, https, https_get, https_post); 1 — строить, 0 — не строить.
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&graph=1&[другие параметры]

algoritm

Обязательный параметр: нет.
Значение по умолчанию: 0.
Значение: 0 — Авто; 1 — Из каждой выбранной точки мониторинга независимо; 2 — Из всех выбранных точек мониторинга (описание алгоритмов проверки).
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&algoritm=0&[другие параметры]

tm

Обязательный параметр: нет (если параметр «algoritm» не указан или 0) / да (если параметр «algoritm» больше 0).
Значение: ID точек мониторинга, полученные с помощью данного метода, через запятую или точку с запятой. Из указанных здесь точек мониторинга будут выполняться проверки.
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&algoritm=2&tm=ru9,ru15&[другие параметры]

vid2_nw

Обязательный параметр: нет.
Значение по умолчанию: 0 (означает половину выбранных точек мониторинга).
Значение: количество точек мониторинга, при получении информации об ошибке от которых будет считаться, что проверяемый сервис не работает. Используется только, если algoritm=2.
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&vid2_nw=2&[другие параметры]

enc

Обязательный параметр: нет.
Значение: если указано «utf8», то в ответе будет заголовок «Content-type: application/json; charset=utf8» и кодировка ответа будет UTF-8.
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&enc=utf8&[остальные парамтеры]

tmout

Обязательный параметр: нет.
Значение по умолчанию: 6.
Значение: максимальное ожидание ответа при проверке сайта от 2 до 8 секунд.
Пример использования:

https://ping-admin.com/?a=api&sa=new_task&tmout=5&[остальные парамтеры]

Ответ на отправленный запрос

Если добавить задачу не удалось (например, переданы неверные параметры в запросе), то в ответе будет информация об ошибке.

Список параметров ответа

tid

Тип: целое число.
Значение: ID добавленной задачи.

← Назад к разделам API