Уведомления - API документация

Извлечь все элементы

Конечная точка

GET https://uptime.bz/api/notification-handler/

Пример

curl --request GET \
--url 'https://uptime.bz/api/notification-handler/' \
--header 'Authorization: Bearer {api_key}' \

Параметры	Детали	Описание
page	Необязательный Integer	Номер страницы, из которого вы хотите получить результаты. По умолчанию используется значение `1`.
results_per_page	Необязательный Integer	Сколько результатов вы хотите получить на странице. Допустимые значения: `10` , `25` , `50` , `100` , `250` , `500` , `1000`. По умолчанию используется `25`.

Пример ответа

{ "data": [ { "id": 1, "type": "email", "name": "Work email", "settings": { "email": "hey@example.com" }, "is_enabled": true, "last_datetime": null, "datetime": "2021-06-27 22:16:23" } ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://uptime.bz/api/notification-handler?&page=1", "last": "https://uptime.bz/api/notification-handler?&page=1", "next": null, "prev": null, "self": "https://uptime.bz/api/notification-handler?&page=1" } }

Извлечь один элемент

Конечная точка

GET https://uptime.bz/api/notification-handler/{notification_handler_id}

Пример

curl --request GET \
--url 'https://uptime.bz/api/notification-handler/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \

Пример ответа

{ "data": { "id": 1, "type": "email", "name": "Work email", "settings": { "email": "hey@example.com" }, "is_enabled": true, "last_datetime": null, "datetime": "2021-06-27 22:16:23" } }

Создать

Конечная точка

POST https://uptime.bz/api/notification-handlers

Параметры	Детали	Описание
name	Требуемый String	-
type	Требуемый String	Допустимые значения: `email` , `webhook` , `slack` , `discord` , `telegram` , `microsoft_teams` , `push_subscriber_id`
email	Необязательный String	Доступно, когда: type = email Эл.почта
webhook	Необязательный String	Доступно, когда: type = webhook Webhook URL
slack	Необязательный String	Доступно, когда: type = slack Slack webhook URL-адрес
discord	Необязательный String	Доступно, когда: type = discord Discord webhook URL-адрес
telegram	Необязательный String	Доступно, когда: type = telegram Telegram API токен
telegram_chat_id	Необязательный String	Доступно, когда: type = telegram Telegram Chat ID

Пример

curl --request POST \
--url 'https://uptime.bz/api/notification-handlers' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'type=email' \
--form 'email=hello@example.com' \

Пример ответа

{ "data": { "id": 1 } }

Обновить

Конечная точка

POST https://uptime.bz/api/notification-handlers/{notification_handler_id}

Параметры	Детали	Описание
name	Необязательный String	-
type	Необязательный String	Допустимые значения: `email` , `webhook` , `slack` , `discord` , `telegram` , `microsoft_teams` , `push_subscriber_id`
email	Необязательный String	Доступно, когда: type = email Эл.почта
webhook	Необязательный String	Доступно, когда: type = webhook Webhook URL
slack	Необязательный String	Доступно, когда: type = slack Slack webhook URL-адрес
discord	Необязательный String	Доступно, когда: type = discord Discord webhook URL-адрес
telegram	Необязательный String	Доступно, когда: type = telegram Telegram API токен
telegram_chat_id	Необязательный String	Доступно, когда: type = telegram Telegram Chat ID
is_enabled	Необязательный Boolean	-

Пример

curl --request POST \
--url 'https://uptime.bz/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example new name' \
--form 'is_enabled=1' \

Пример ответа

{ "data": { "id": 1 } }

Удалить

Конечная точка

DELETE https://uptime.bz/api/notification-handlers/{notification_handler_id}

Пример

curl --request DELETE \
--url 'https://uptime.bz/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \