Мониторы

Примечания
Для опытных пользователей
Передавайте ключ API как токен Bearer в заголовке Authorization. Получить ключ API.
Список

Адрес API:

GET 
https://api.tuptime.ru/v1/monitors

Пример запроса: 

curl --location --request GET 'https://api.tuptime.ru/v1/monitors' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Параметр
Тип
Описание
search
необязательно string
Поисковый запрос.
search_by
необязательно string
Искать по. Допустимые значения: name — Название, url — URL. По умолчанию: name.
status_page_id
необязательно integer
ID страницы статуса.
sort_by
необязательно string
Сортировать по. Допустимые значения: id — Дата создания, name — Название, url — URL. По умолчанию: id.
sort
необязательно string
Сортировка. Допустимые значения: desc — По убыванию, asc — По возрастанию. По умолчанию: desc.
per_page
необязательно integer
Записей на странице. Допустимые значения: 10, 25, 50, 100. По умолчанию: 10.
Посмотреть

Адрес API:

GET 
https://api.tuptime.ru/v1/monitors/{id}

Пример запроса: 

curl --location --request GET 'https://api.tuptime.ru/v1/monitors/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Создать

Адрес API:

POST 
https://api.tuptime.ru/v1/monitors

Пример запроса: 

curl --location --request POST 'https://api.tuptime.ru/v1/monitors' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}' \
--data-urlencode 'url={url}' \
--data-urlencode 'interval={interval}'
Параметр
Тип
Описание
name
обязательно string
Название.
url
обязательно string
URL.
interval
обязательно integer
Интервал. Допустимые значения: 60, 180, 300, 600, 900, 1800, 3600.
alert_condition
необязательно string
Условие оповещения. Допустимые значения: url_unavailable — Сайт становится недоступен, url_text — Ответ содержит заданный текст, url_no_text — Ответ не содержит заданный текст. По умолчанию: url_unavailable.
alert_text_lookup
необязательно string
Текст, наличие или отсутствие которого вызывает оповещение. Работает, только если в поле alert_condition указано url_text, url_no_text.
request_method
необязательно string
Метод запроса. Допустимые значения: GET, POST, HEAD, PUT, DELETE, PATCH, OPTIONS. По умолчанию: GET.
request_headers[index][key]
необязательно string
Название заголовка запроса.
request_headers[index][value]
необязательно string
Значение заголовка запроса.
request_auth_username
необязательно string
Имя пользователя для базовой HTTP-аутентификации.
request_auth_password
необязательно string
Пароль для базовой HTTP-аутентификации.
cache_buster
необязательно integer
Обход кеша. Допустимые значения: 0 — Отключено, 1 — Включено. По умолчанию: 0.
ssl_alert_days
необязательно integer
За сколько дней до окончания срока SSL-сертификата отправить оповещение. Допустимые значения: 0, 1, 2, 3, 7, 14, 30, 60.
domain_alert_days
необязательно integer
За сколько дней до окончания регистрации домена отправить оповещение. Допустимые значения: 0, 1, 2, 3, 7, 14, 30, 60.
maintenance_start_at
необязательно string
Дата начала технических работ в формате Y-m-dTH:i:s.
maintenance_end_at
необязательно string
Дата окончания технических работ в формате Y-m-dTH:i:s.
alerts[index][key]
необязательно string
Каналы оповещений. Допустимые значения: email — Email, webhook — Webhook, slack — Slack, teams — Microsoft Teams, discord — Discord, flock — Flock, telegram — Telegram, sms — SMS.
alerts[index][value]
необязательно string
Адрес или идентификатор получателя оповещения.
Обновить

Адрес API:

PUT PATCH 
https://api.tuptime.ru/v1/monitors/{id}

Пример запроса: 

curl --location --request PUT 'https://api.tuptime.ru/v1/monitors/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Параметр
Тип
Описание
name
необязательно string
Название.
url
необязательно string
URL.
interval
необязательно integer
Интервал. Допустимые значения: 60, 180, 300, 600, 900, 1800, 3600.
alert_condition
необязательно string
Условие оповещения. Допустимые значения: url_unavailable — Сайт становится недоступен, url_text — Ответ содержит заданный текст, url_no_text — Ответ не содержит заданный текст. По умолчанию: url_unavailable.
alert_text_lookup
необязательно string
Текст, наличие или отсутствие которого вызывает оповещение. Работает, только если в поле alert_condition указано url_text, url_no_text.
request_method
необязательно string
Метод запроса. Допустимые значения: GET, POST, HEAD, PUT, DELETE, PATCH, OPTIONS. По умолчанию: GET.
request_headers[index][key]
необязательно string
Название заголовка запроса.
request_headers[index][value]
необязательно string
Значение заголовка запроса.
request_auth_username
необязательно string
Имя пользователя для базовой HTTP-аутентификации.
request_auth_password
необязательно string
Пароль для базовой HTTP-аутентификации.
cache_buster
необязательно integer
Обход кеша. Допустимые значения: 0 — Отключено, 1 — Включено.
ssl_alert_days
необязательно integer
За сколько дней до окончания срока SSL-сертификата отправить оповещение. Допустимые значения: 0, 1, 2, 3, 7, 14, 30, 60.
domain_alert_days
необязательно integer
За сколько дней до окончания регистрации домена отправить оповещение. Допустимые значения: 0, 1, 2, 3, 7, 14, 30, 60.
maintenance_start_at
необязательно string
Дата начала технических работ в формате Y-m-dTH:i:s.
maintenance_end_at
необязательно string
Дата окончания технических работ в формате Y-m-dTH:i:s.
alerts[index][key]
необязательно string
Каналы оповещений. Допустимые значения: email — Email, webhook — Webhook, slack — Slack, teams — Microsoft Teams, discord — Discord, flock — Flock, telegram — Telegram, sms — SMS.
alerts[index][value]
необязательно string
Адрес или идентификатор получателя оповещения.
pause
необязательно boolean
Приостановить.
Удалить

Адрес API:

DELETE 
https://api.tuptime.ru/v1/monitors/{id}

Пример запроса: 

curl --location --request DELETE 'https://api.tuptime.ru/v1/monitors/{id}' \
--header 'Authorization: Bearer {api_key}'