← Tools Reference

Healthchecks.io

Healthchecks.io integration (Developer Tools). Imported from open-connector.

API key11 toolshttps://healthchecks.io/api/v3
GET
healthchecks_io_list_checks
List Healthchecks.io checks in the current project.

/checks/

1 parameter
ParamTypeRequiredDescription
slugstringoptionalOnly return checks with this slug.
GET
healthchecks_io_get_check
Get a Healthchecks.io check by UUID or unique key.

/checks/{check_id}

1 parameter
ParamTypeRequiredDescription
check_idstringrequiredThe Healthchecks.io check UUID or unique key used in the Management API path.
POST
healthchecks_io_create_check
Create a Healthchecks.io simple or cron check.

/checks/

18 parameters
ParamTypeRequiredDescription
namestringoptionalThe human-readable check name.
slugstringoptionalThe custom check slug.
tagsstringoptionalA space-delimited list of tags assigned to the check.
descstringoptionalThe check description.
timeoutintegeroptionalThe simple check timeout in seconds.
graceintegeroptionalThe grace period in seconds.
schedulestringoptionalA cron or systemd OnCalendar expression defining the check schedule.
tzstringoptionalThe timezone used with the schedule field, such as Europe/Riga.
manual_resumebooleanoptionalWhether the check should stay down until manually resumed.
methodsstringoptionalThe allowed HTTP methods for ping requests, such as POST.
channelsstringoptionalA comma-separated list of channel UUIDs or names, * for all channels, or an emp…
start_kwstringoptionalComma-separated keywords that mark inbound email or HTTP pings as starts.
success_kwstringoptionalComma-separated keywords that mark inbound email or HTTP pings as successes.
failure_kwstringoptionalComma-separated keywords that mark inbound email or HTTP pings as failures.
filter_subjectbooleanoptionalWhether inbound email subject lines should be keyword-filtered.
filter_bodybooleanoptionalWhether inbound email bodies should be keyword-filtered.
filter_http_bodybooleanoptionalWhether HTTP ping bodies should be keyword-filtered.
filter_default_failbooleanoptionalWhether unmatched pings should be treated as failures when keyword filtering is…
POST
healthchecks_io_update_check
Update a Healthchecks.io check by UUID.

/checks/{uuid}

19 parameters
ParamTypeRequiredDescription
uuidstringrequiredThe Healthchecks.io check UUID used in the API path.
namestringoptionalThe human-readable check name.
slugstringoptionalThe custom check slug.
tagsstringoptionalA space-delimited list of tags assigned to the check.
descstringoptionalThe check description.
timeoutintegeroptionalThe simple check timeout in seconds.
graceintegeroptionalThe grace period in seconds.
schedulestringoptionalA cron or systemd OnCalendar expression defining the check schedule.
tzstringoptionalThe timezone used with the schedule field, such as Europe/Riga.
manual_resumebooleanoptionalWhether the check should stay down until manually resumed.
methodsstringoptionalThe allowed HTTP methods for ping requests, such as POST.
channelsstringoptionalA comma-separated list of channel UUIDs or names, * for all channels, or an emp…
start_kwstringoptionalComma-separated keywords that mark inbound email or HTTP pings as starts.
success_kwstringoptionalComma-separated keywords that mark inbound email or HTTP pings as successes.
failure_kwstringoptionalComma-separated keywords that mark inbound email or HTTP pings as failures.
filter_subjectbooleanoptionalWhether inbound email subject lines should be keyword-filtered.
filter_bodybooleanoptionalWhether inbound email bodies should be keyword-filtered.
filter_http_bodybooleanoptionalWhether HTTP ping bodies should be keyword-filtered.
filter_default_failbooleanoptionalWhether unmatched pings should be treated as failures when keyword filtering is…
POST
healthchecks_io_pause_check
Pause monitoring for a Healthchecks.io check by UUID.

/checks/{uuid}/pause

1 parameter
ParamTypeRequiredDescription
uuidstringrequiredThe Healthchecks.io check UUID used in the API path.
POST
healthchecks_io_resume_check
Resume monitoring for a Healthchecks.io check by UUID.

/checks/{uuid}/resume

1 parameter
ParamTypeRequiredDescription
uuidstringrequiredThe Healthchecks.io check UUID used in the API path.
DELETE
healthchecks_io_delete_check
Delete a Healthchecks.io check by UUID.

/checks/{uuid}

1 parameter
ParamTypeRequiredDescription
uuidstringrequiredThe Healthchecks.io check UUID used in the API path.
GET
healthchecks_io_list_pings
List recent Healthchecks.io pings for a check by UUID.

/checks/{uuid}/pings/

1 parameter
ParamTypeRequiredDescription
uuidstringrequiredThe Healthchecks.io check UUID used in the API path.
GET
healthchecks_io_list_flips
List Healthchecks.io status flips for a check by UUID or unique key.

/checks/{check_id}/flips/

4 parameters
ParamTypeRequiredDescription
check_idstringrequiredThe Healthchecks.io check UUID or unique key used in the Management API path.
secondsintegeroptionalOnly return flips in the latest number of seconds.
startintegeroptionalA UNIX timestamp in seconds.
endintegeroptionalA UNIX timestamp in seconds.
GET
healthchecks_io_list_channels
List notification integrations in the current Healthchecks.io project.

/channels/

GET
healthchecks_io_list_badges
List badge metadata in the current Healthchecks.io project.

/badges/