Heartbeats

Retrieve all

GET https://health-test.toffeelive.com/api/heartbeats/
curl --request GET \
--url 'https://health-test.toffeelive.com/api/heartbeats/' \
--header 'Authorization: Bearer {api_key}' \
Parameters Details Description
page Optional Integer The page number that you want results from. Defaults to 1.
results_per_page Optional Integer How many results you want per page. Allowed values are: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Defaults to 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": "2021-03-09 11:30:20" } ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://health-test.toffeelive.com/api/heartbeats?&page=1", "last": "https://health-test.toffeelive.com/api/heartbeats?&page=1", "next": null, "prev": null, "self": "https://health-test.toffeelive.com/api/heartbeats?&page=1" } }

Retrieve one

GET https://health-test.toffeelive.com/api/heartbeats/{heartbeat_id}
curl --request GET \
--url 'https://health-test.toffeelive.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": "2021-03-09 11:30:20" } }

Create

POST https://health-test.toffeelive.com/api/heartbeats
Parameters Details Description
name Required String -
run_interval Optional Integer -
run_interval_type Optional String Allowed values: seconds, minutes, hours, days
run_interval_grace Optional Integer -
run_interval_grace_type Optional String Allowed values: seconds, minutes, hours, days
is_ok_notifications Optional Array Notification handler ids
is_enabled Optional Boolean -
curl --request POST \
--url 'https://health-test.toffeelive.com/api/heartbeats' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'target=example.com' \
{ "data": { "id": 1 } }

Update

POST https://health-test.toffeelive.com/api/heartbeats/{heartbeat_id}
Parameters Details Description
name Optional String -
run_interval Optional Integer -
run_interval_type Optional String Allowed values: seconds, minutes, hours, days
run_interval_grace Optional Integer -
run_interval_grace_type Optional String Allowed values: seconds, minutes, hours, days
is_ok_notifications Optional Array Notification handler ids
is_enabled Optional Boolean -
curl --request POST \
--url 'https://health-test.toffeelive.com/api/heartbeats/{heartbeat_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
{ "data": { "id": 1 } }

Delete

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