Мониторы доступности

Получить все

GET https://hostmon.ru/api/monitors/
curl --request GET \
--url 'https://hostmon.ru/api/monitors/' \
--header 'Authorization: Bearer {api_key}' \
Параметры Подробно Описание
page Опциональный Целое число Номер страницы, с которой вы хотите получить результаты. По умолчанию используется значение 1.
results_per_page Опциональный Целое число Сколько результатов вы хотите получить на странице. Допустимые значения: 10 , 25 , 50 , 100 , 250 , 500 , 1000. По умолчанию используется значение 25.
{ "data": [ { "id": 1, "project_id": 0, "name": "Example", "type": "website", "target": "https://example.com/", "port": 0, "settings": { "check_interval_seconds": 3600, "timeout_seconds": 1, "request_method": "GET", "request_body": "", "request_basic_auth_username": "", "request_basic_auth_password": "", "request_headers": [], "response_status_code": 200, "response_body": "", "response_headers": [] }, "ping_servers_ids": [1], "is_ok": 1, "uptime": 95.5, "downtime": 4.5, "average_response_time": 500, "total_checks": 500, "total_ok_checks": 450, "total_not_ok_checks": 50, "last_check_datetime": "2021-03-25 08:27:07", "notifications": { "email_is_enabled": 0, "webhook":"", "slack":"", "twilio":"" }, "is_enabled": false, "datetime": "2021-02-12 21:54:29" } ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://hostmon.ru/api/monitors?&page=1", "last": "https://hostmon.ru/api/monitors?&page=1", "next": null, "prev": null, "self": "https://hostmon.ru/api/monitors?&page=1" } }

Получить один

GET https://hostmon.ru/api/monitors/{monitor_id}
curl --request GET \
--url 'https://hostmon.ru/api/monitors/{monitor_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 1, "project_id": 0, "name": "Example", "type": "website", "target": "https://example.com/", "port": 0, "settings": { "check_interval_seconds": 3600, "timeout_seconds": 1, "request_method": "GET", "request_body": "", "request_basic_auth_username": "", "request_basic_auth_password": "", "request_headers": [], "response_status_code": 200, "response_body": "", "response_headers": [] }, "ping_servers_ids": [1], "is_ok": 1, "uptime": 95.5, "downtime": 4.5, "average_response_time": 500, "total_checks": 500, "total_ok_checks": 450, "total_not_ok_checks": 50, "last_check_datetime": "2021-03-25 08:27:07", "notifications": { "email_is_enabled": 0, "webhook":"", "slack":"", "twilio":"" }, "is_enabled": false, "datetime": "2021-02-12 21:54:29" } }

Создать

POST https://hostmon.ru/api/monitors
Параметры Подробно Описание
name Обязательный Строка -
target Обязательный Строка -
port Опциональный Строка -
type Опциональный Строка Допустимые значения: website, ping, port
project_id Опциональный Целое число -
ping_servers_ids Опциональный Массив Допустимые значения: 1, 2, 3, 4, 5
check_interval_seconds Опциональный Целое число Допустимые значения: 60, 180, 300, 600, 1800, 3600, 21600, 43200, 86400 (сек.)
timeout_seconds Опциональный Целое число Допустимые значения: 1, 2, 3, 5, 10, 25 (сек.)
request_method Опциональный Строка Допустимые значения: HEAD, GET, POST, PUT, PATCH
request_body Опциональный Строка -
request_basic_auth_username Опциональный Строка -
request_basic_auth_password Опциональный Строка -
request_header_name Опциональный Массив -
request_header_value Опциональный Массив -
response_status_code Опциональный Целое число -
response_body Опциональный Строка -
response_header_name Опциональный Строка -
response_header_value Опциональный Строка -
is_ok_notifications Опциональный Массив Идентификаторы каналов
email_reports_is_enabled Опциональный Логический -
cache_buster_is_enabled Опциональный Логический -
verify_ssl_is_enabled Опциональный Логический -
is_enabled Опциональный Логический -
curl --request POST \
--url 'https://hostmon.ru/api/monitors' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'target=https://example.com/' \
{ "data": { "id": 1 } }

Обновить

POST https://hostmon.ru/api/monitors/{monitor_id}
Параметры Подробно Описание
name Опциональный Строка -
target Опциональный Строка -
port Опциональный Строка -
type Опциональный Строка Допустимые значения: website, ping, port
project_id Опциональный Целое число -
ping_servers_ids Опциональный Массив Допустимые значения: 1, 2, 3, 4, 5
check_interval_seconds Опциональный Целое число Допустимые значения: 60, 180, 300, 600, 1800, 3600, 21600, 43200, 86400 (сек.)
timeout_seconds Опциональный Целое число Допустимые значения: 1, 2, 3, 5, 10, 25 (сек.)
request_method Опциональный Строка Допустимые значения: HEAD, GET, POST, PUT, PATCH
request_body Опциональный Строка -
request_basic_auth_username Опциональный Строка -
request_basic_auth_password Опциональный Строка -
request_header_name Опциональный Массив -
request_header_value Опциональный Массив -
response_status_code Опциональный Целое число -
response_body Опциональный Строка -
response_header_name Опциональный Строка -
response_header_value Опциональный Строка -
is_ok_notifications Опциональный Массив Идентификаторы каналов
email_reports_is_enabled Опциональный Логический -
cache_buster_is_enabled Опциональный Логический -
verify_ssl_is_enabled Опциональный Логический -
is_enabled Опциональный Логический -
curl --request POST \
--url 'https://hostmon.ru/api/monitors/{monitor_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
{ "data": { "id": 1 } }

Удалить

DELETE https://hostmon.ru/api/monitors/{monitor_id}
curl --request DELETE \
--url 'https://hostmon.ru/api/monitors/{monitor_id}' \
--header 'Authorization: Bearer {api_key}' \