Сердцебиения - Документация API

Получить все

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

GET https://uptime4.com/api/heartbeats/

Пример

curl --request GET \
--url 'https://uptime4.com/api/heartbeats/' \
--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": "Demo cron", "code": "12345678901112131415", "settings": { "run_interval": 1, "run_interval_type": "minutes", "run_interval_grace": 1, "run_interval_grace_type": "seconds" }, "is_ok": 1, "uptime": 75.5, "downtime": 24.5, "total_runs": 50, "total_missed_runs": 15, "last_run_datetime": "2021-03-30 19:17:22", "notifications": { "email_is_enabled": 0, "webhook": "", "slack": "", "twilio": "" }, "is_enabled": true, "datetime": "2025-02-23 19:29:20" } ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://uptime4.com/api/heartbeats?&page=1", "last": "https://uptime4.com/api/heartbeats?&page=1", "next": null, "prev": null, "self": "https://uptime4.com/api/heartbeats?&page=1" } }

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

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

GET https://uptime4.com/api/heartbeats/{heartbeat_id}

Пример

curl --request GET \
--url 'https://uptime4.com/api/heartbeats/{heartbeat_id}' \
--header 'Authorization: Bearer {api_key}' \

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

{ "data": { "id": 1, "project_id": 0, "name": "Demo cron", "code": "12345678901112131415", "settings": { "run_interval": 1, "run_interval_type": "minutes", "run_interval_grace": 1, "run_interval_grace_type": "seconds" }, "is_ok": 1, "uptime": 75.5, "downtime": 24.5, "total_runs": 50, "total_missed_runs": 15, "last_run_datetime": "2021-03-30 19:17:22", "notifications": { "email_is_enabled": 0, "webhook": "", "slack": "", "twilio": "" }, "is_enabled": true, "datetime": "2025-02-23 19:29:20" } }

Создать

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

POST https://uptime4.com/api/heartbeats

Параметры	Детали	Описание
name	Обязательно Строка	-
run_interval	Необязательный Целое число	-
run_interval_type	Необязательный Строка	Разрешенные значения: `seconds`, `minutes`, `hours`, `days`
run_interval_grace	Необязательный Целое число	-
run_interval_grace_type	Необязательный Строка	Разрешенные значения: `seconds`, `minutes`, `hours`, `days`
is_ok_notifications	Необязательный Массив	Идентификаторы обработчиков уведомлений
is_enabled	Необязательный Булевый	-

Пример

curl --request POST \
--url 'https://uptime4.com/api/heartbeats' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'target=example.com' \

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

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

Обновить

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

POST https://uptime4.com/api/heartbeats/{heartbeat_id}

Параметры	Детали	Описание
name	Необязательный Строка	-
run_interval	Необязательный Целое число	-
run_interval_type	Необязательный Строка	Разрешенные значения: `seconds`, `minutes`, `hours`, `days`
run_interval_grace	Необязательный Целое число	-
run_interval_grace_type	Необязательный Строка	Разрешенные значения: `seconds`, `minutes`, `hours`, `days`
is_ok_notifications	Необязательный Массив	Идентификаторы обработчиков уведомлений
is_enabled	Необязательный Булевый	-

Пример

curl --request POST \
--url 'https://uptime4.com/api/heartbeats/{heartbeat_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \

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

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

Удалить

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

DELETE https://uptime4.com/api/heartbeats/{heartbeat_id}

Пример

curl --request DELETE \
--url 'https://uptime4.com/api/heartbeats/{heartbeat_id}' \
--header 'Authorization: Bearer {api_key}' \