analytics
Healthchecks.io CLI for AI Agents
Use the Healthchecks.io CLI from KosmoKrator to call Healthchecks.io tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.Healthchecks.io CLI Setup
Healthchecks.io can be configured headlessly with `kosmokrator integrations:configure healthchecks-io`.
# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash
# Configure and verify this integration.
kosmokrator integrations:configure healthchecks-io --enable --read allow --write ask --json
kosmokrator integrations:doctor healthchecks-io --json
kosmokrator integrations:status --json Credentials
Authentication type: API key api_key. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.
No credentials are required.
Command Patterns
The generic command is stable across every integration. The provider shortcut is shorter for humans.
kosmo integrations:call healthchecks-io.healthchecks_io_list_checks '{"slug":"example_slug","tag":"example_tag"}' --json kosmo integrations:healthchecks-io healthchecks_io_list_checks '{"slug":"example_slug","tag":"example_tag"}' --json Discovery
These commands return structured output for coding agents that need to inspect capabilities before choosing a function.
kosmo integrations:docs healthchecks-io --json
kosmo integrations:docs healthchecks-io.healthchecks_io_list_checks --json
kosmo integrations:schema healthchecks-io.healthchecks_io_list_checks --json
kosmo integrations:search "Healthchecks.io" --json
kosmo integrations:list --json Automation Contexts
The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.
CLI Functions
Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.
healthchecks-io.healthchecks_io_list_checks
List existing checks Official Healthchecks.io endpoint: GET https://healthchecks.io/api/v3/checks/.
read - Parameters
- slug, tag
kosmo integrations:call healthchecks-io.healthchecks_io_list_checks '{"slug":"example_slug","tag":"example_tag"}' --json kosmo integrations:healthchecks-io healthchecks_io_list_checks '{"slug":"example_slug","tag":"example_tag"}' --json healthchecks-io.healthchecks_io_get_check
Get a single check by UUID or unique key Official Healthchecks.io endpoint: GET https://healthchecks.io/api/v3/checks/{check_id}.
read - Parameters
- check_id
kosmo integrations:call healthchecks-io.healthchecks_io_get_check '{"check_id":"example_check_id"}' --json kosmo integrations:healthchecks-io healthchecks_io_get_check '{"check_id":"example_check_id"}' --json healthchecks-io.healthchecks_io_create_check
Create a new check Official Healthchecks.io endpoint: POST https://healthchecks.io/api/v3/checks/.
write - Parameters
- body
kosmo integrations:call healthchecks-io.healthchecks_io_create_check '{"body":"example_body"}' --json kosmo integrations:healthchecks-io healthchecks_io_create_check '{"body":"example_body"}' --json healthchecks-io.healthchecks_io_update_check
Update an existing check Official Healthchecks.io endpoint: POST https://healthchecks.io/api/v3/checks/{uuid}.
write - Parameters
- uuid, body
kosmo integrations:call healthchecks-io.healthchecks_io_update_check '{"uuid":"example_uuid","body":"example_body"}' --json kosmo integrations:healthchecks-io healthchecks_io_update_check '{"uuid":"example_uuid","body":"example_body"}' --json healthchecks-io.healthchecks_io_pause_check
Pause monitoring of a check Official Healthchecks.io endpoint: POST https://healthchecks.io/api/v3/checks/{uuid}/pause.
write - Parameters
- uuid
kosmo integrations:call healthchecks-io.healthchecks_io_pause_check '{"uuid":"example_uuid"}' --json kosmo integrations:healthchecks-io healthchecks_io_pause_check '{"uuid":"example_uuid"}' --json healthchecks-io.healthchecks_io_resume_check
Resume monitoring of a check Official Healthchecks.io endpoint: POST https://healthchecks.io/api/v3/checks/{uuid}/resume.
write - Parameters
- uuid
kosmo integrations:call healthchecks-io.healthchecks_io_resume_check '{"uuid":"example_uuid"}' --json kosmo integrations:healthchecks-io healthchecks_io_resume_check '{"uuid":"example_uuid"}' --json healthchecks-io.healthchecks_io_delete_check
Delete a check Official Healthchecks.io endpoint: DELETE https://healthchecks.io/api/v3/checks/{uuid}.
write - Parameters
- uuid
kosmo integrations:call healthchecks-io.healthchecks_io_delete_check '{"uuid":"example_uuid"}' --json kosmo integrations:healthchecks-io healthchecks_io_delete_check '{"uuid":"example_uuid"}' --json healthchecks-io.healthchecks_io_list_pings
List a check's logged pings Official Healthchecks.io endpoint: GET https://healthchecks.io/api/v3/checks/{uuid}/pings/.
read - Parameters
- uuid
kosmo integrations:call healthchecks-io.healthchecks_io_list_pings '{"uuid":"example_uuid"}' --json kosmo integrations:healthchecks-io healthchecks_io_list_pings '{"uuid":"example_uuid"}' --json healthchecks-io.healthchecks_io_get_ping_body
Get a ping's logged body Official Healthchecks.io endpoint: GET https://healthchecks.io/api/v3/checks/{uuid}/pings/{n}/body.
read - Parameters
- uuid, n
kosmo integrations:call healthchecks-io.healthchecks_io_get_ping_body '{"uuid":"example_uuid","n":1}' --json kosmo integrations:healthchecks-io healthchecks_io_get_ping_body '{"uuid":"example_uuid","n":1}' --json healthchecks-io.healthchecks_io_list_flips
List a check's status changes Official Healthchecks.io endpoint: GET https://healthchecks.io/api/v3/checks/{check_id}/flips/.
read - Parameters
- check_id, seconds, start, end
kosmo integrations:call healthchecks-io.healthchecks_io_list_flips '{"check_id":"example_check_id","seconds":1,"start":1,"end":1}' --json kosmo integrations:healthchecks-io healthchecks_io_list_flips '{"check_id":"example_check_id","seconds":1,"start":1,"end":1}' --json healthchecks-io.healthchecks_io_list_channels
List existing integrations/channels Official Healthchecks.io endpoint: GET https://healthchecks.io/api/v3/channels/.
read - Parameters
- none
kosmo integrations:call healthchecks-io.healthchecks_io_list_channels '{}' --json kosmo integrations:healthchecks-io healthchecks_io_list_channels '{}' --json healthchecks-io.healthchecks_io_list_badges
List project's badges Official Healthchecks.io endpoint: GET https://healthchecks.io/api/v3/badges/.
read - Parameters
- none
kosmo integrations:call healthchecks-io.healthchecks_io_list_badges '{}' --json kosmo integrations:healthchecks-io healthchecks_io_list_badges '{}' --json healthchecks-io.healthchecks_io_get_status
Check Healthchecks.io database connectivity Official Healthchecks.io endpoint: GET https://healthchecks.io/api/v3/status/.
read - Parameters
- none
kosmo integrations:call healthchecks-io.healthchecks_io_get_status '{}' --json kosmo integrations:healthchecks-io healthchecks_io_get_status '{}' --json healthchecks-io.healthchecks_io_ping_success_uuid
Send a success uuid ping signal Official Healthchecks.io endpoint: POST https://hc-ping.com/{uuid}.
read - Parameters
- uuid, rid, http_method, body_text
kosmo integrations:call healthchecks-io.healthchecks_io_ping_success_uuid '{"uuid":"example_uuid","rid":"example_rid","http_method":"example_http_method","body_text":"example_body_text"}' --json kosmo integrations:healthchecks-io healthchecks_io_ping_success_uuid '{"uuid":"example_uuid","rid":"example_rid","http_method":"example_http_method","body_text":"example_body_text"}' --json healthchecks-io.healthchecks_io_ping_start_uuid
Send a start uuid ping signal Official Healthchecks.io endpoint: POST https://hc-ping.com/{uuid}/start.
read - Parameters
- uuid, rid, http_method, body_text
kosmo integrations:call healthchecks-io.healthchecks_io_ping_start_uuid '{"uuid":"example_uuid","rid":"example_rid","http_method":"example_http_method","body_text":"example_body_text"}' --json kosmo integrations:healthchecks-io healthchecks_io_ping_start_uuid '{"uuid":"example_uuid","rid":"example_rid","http_method":"example_http_method","body_text":"example_body_text"}' --json healthchecks-io.healthchecks_io_ping_fail_uuid
Send a fail uuid ping signal Official Healthchecks.io endpoint: POST https://hc-ping.com/{uuid}/fail.
read - Parameters
- uuid, rid, http_method, body_text
kosmo integrations:call healthchecks-io.healthchecks_io_ping_fail_uuid '{"uuid":"example_uuid","rid":"example_rid","http_method":"example_http_method","body_text":"example_body_text"}' --json kosmo integrations:healthchecks-io healthchecks_io_ping_fail_uuid '{"uuid":"example_uuid","rid":"example_rid","http_method":"example_http_method","body_text":"example_body_text"}' --json healthchecks-io.healthchecks_io_ping_log_uuid
Send a log uuid ping signal Official Healthchecks.io endpoint: POST https://hc-ping.com/{uuid}/log.
read - Parameters
- uuid, rid, http_method, body_text
kosmo integrations:call healthchecks-io.healthchecks_io_ping_log_uuid '{"uuid":"example_uuid","rid":"example_rid","http_method":"example_http_method","body_text":"example_body_text"}' --json kosmo integrations:healthchecks-io healthchecks_io_ping_log_uuid '{"uuid":"example_uuid","rid":"example_rid","http_method":"example_http_method","body_text":"example_body_text"}' --json healthchecks-io.healthchecks_io_ping_exit_status_uuid
Send a exit status uuid ping signal Official Healthchecks.io endpoint: POST https://hc-ping.com/{uuid}/{exit_status}.
read - Parameters
- uuid, exit_status, rid, http_method, body_text
kosmo integrations:call healthchecks-io.healthchecks_io_ping_exit_status_uuid '{"uuid":"example_uuid","exit_status":1,"rid":"example_rid","http_method":"example_http_method","body_text":"example_body_text"}' --json kosmo integrations:healthchecks-io healthchecks_io_ping_exit_status_uuid '{"uuid":"example_uuid","exit_status":1,"rid":"example_rid","http_method":"example_http_method","body_text":"example_body_text"}' --json healthchecks-io.healthchecks_io_ping_success_slug
Send a success slug ping signal Official Healthchecks.io endpoint: POST https://hc-ping.com/{ping_key}/{slug}.
read - Parameters
- ping_key, slug, rid, create, http_method, body_text
kosmo integrations:call healthchecks-io.healthchecks_io_ping_success_slug '{"ping_key":"example_ping_key","slug":"example_slug","rid":"example_rid","create":"example_create","http_method":"example_http_method","body_text":"example_body_text"}' --json kosmo integrations:healthchecks-io healthchecks_io_ping_success_slug '{"ping_key":"example_ping_key","slug":"example_slug","rid":"example_rid","create":"example_create","http_method":"example_http_method","body_text":"example_body_text"}' --json healthchecks-io.healthchecks_io_ping_start_slug
Send a start slug ping signal Official Healthchecks.io endpoint: POST https://hc-ping.com/{ping_key}/{slug}/start.
read - Parameters
- ping_key, slug, rid, create, http_method, body_text
kosmo integrations:call healthchecks-io.healthchecks_io_ping_start_slug '{"ping_key":"example_ping_key","slug":"example_slug","rid":"example_rid","create":"example_create","http_method":"example_http_method","body_text":"example_body_text"}' --json kosmo integrations:healthchecks-io healthchecks_io_ping_start_slug '{"ping_key":"example_ping_key","slug":"example_slug","rid":"example_rid","create":"example_create","http_method":"example_http_method","body_text":"example_body_text"}' --json healthchecks-io.healthchecks_io_ping_fail_slug
Send a fail slug ping signal Official Healthchecks.io endpoint: POST https://hc-ping.com/{ping_key}/{slug}/fail.
read - Parameters
- ping_key, slug, rid, create, http_method, body_text
kosmo integrations:call healthchecks-io.healthchecks_io_ping_fail_slug '{"ping_key":"example_ping_key","slug":"example_slug","rid":"example_rid","create":"example_create","http_method":"example_http_method","body_text":"example_body_text"}' --json kosmo integrations:healthchecks-io healthchecks_io_ping_fail_slug '{"ping_key":"example_ping_key","slug":"example_slug","rid":"example_rid","create":"example_create","http_method":"example_http_method","body_text":"example_body_text"}' --json healthchecks-io.healthchecks_io_ping_log_slug
Send a log slug ping signal Official Healthchecks.io endpoint: POST https://hc-ping.com/{ping_key}/{slug}/log.
read - Parameters
- ping_key, slug, rid, create, http_method, body_text
kosmo integrations:call healthchecks-io.healthchecks_io_ping_log_slug '{"ping_key":"example_ping_key","slug":"example_slug","rid":"example_rid","create":"example_create","http_method":"example_http_method","body_text":"example_body_text"}' --json kosmo integrations:healthchecks-io healthchecks_io_ping_log_slug '{"ping_key":"example_ping_key","slug":"example_slug","rid":"example_rid","create":"example_create","http_method":"example_http_method","body_text":"example_body_text"}' --json healthchecks-io.healthchecks_io_ping_exit_status_slug
Send a exit status slug ping signal Official Healthchecks.io endpoint: POST https://hc-ping.com/{ping_key}/{slug}/{exit_status}.
read - Parameters
- ping_key, slug, exit_status, rid, create, http_method, body_text
kosmo integrations:call healthchecks-io.healthchecks_io_ping_exit_status_slug '{"ping_key":"example_ping_key","slug":"example_slug","exit_status":1,"rid":"example_rid","create":"example_create","http_method":"example_http_method","body_text":"example_body_text"}' --json kosmo integrations:healthchecks-io healthchecks_io_ping_exit_status_slug '{"ping_key":"example_ping_key","slug":"example_slug","exit_status":1,"rid":"example_rid","create":"example_create","http_method":"example_http_method","body_text":"example_body_text"}' --json Function Schemas
Use these parameter tables when building CLI payloads without calling integrations:schema first.
healthchecks-io.healthchecks_io_list_checks 2 parameters
kosmo integrations:schema healthchecks-io.healthchecks_io_list_checks --json | Parameter | Type | Required | Description |
|---|---|---|---|
slug | string | no | slug query parameter |
tag | string | no | tag query parameter |
healthchecks-io.healthchecks_io_get_check 1 parameters
kosmo integrations:schema healthchecks-io.healthchecks_io_get_check --json | Parameter | Type | Required | Description |
|---|---|---|---|
check_id | string | yes | check id path parameter |
healthchecks-io.healthchecks_io_create_check 1 parameters
kosmo integrations:schema healthchecks-io.healthchecks_io_create_check --json | Parameter | Type | Required | Description |
|---|---|---|---|
body | object | no | JSON request body matching the official Healthchecks.io Management API parameters. |
healthchecks-io.healthchecks_io_update_check 2 parameters
kosmo integrations:schema healthchecks-io.healthchecks_io_update_check --json | Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | yes | uuid path parameter |
body | object | no | JSON request body matching the official Healthchecks.io Management API parameters. |
healthchecks-io.healthchecks_io_pause_check 1 parameters
kosmo integrations:schema healthchecks-io.healthchecks_io_pause_check --json | Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | yes | uuid path parameter |
healthchecks-io.healthchecks_io_resume_check 1 parameters
kosmo integrations:schema healthchecks-io.healthchecks_io_resume_check --json | Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | yes | uuid path parameter |
healthchecks-io.healthchecks_io_delete_check 1 parameters
kosmo integrations:schema healthchecks-io.healthchecks_io_delete_check --json | Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | yes | uuid path parameter |
healthchecks-io.healthchecks_io_list_pings 1 parameters
kosmo integrations:schema healthchecks-io.healthchecks_io_list_pings --json | Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | yes | uuid path parameter |
healthchecks-io.healthchecks_io_get_ping_body 2 parameters
kosmo integrations:schema healthchecks-io.healthchecks_io_get_ping_body --json | Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | yes | uuid path parameter |
n | number | yes | n path parameter |
healthchecks-io.healthchecks_io_list_flips 4 parameters
kosmo integrations:schema healthchecks-io.healthchecks_io_list_flips --json | Parameter | Type | Required | Description |
|---|---|---|---|
check_id | string | yes | check id path parameter |
seconds | number | no | seconds query parameter |
start | number | no | start query parameter |
end | number | no | end query parameter |
healthchecks-io.healthchecks_io_list_channels 0 parameters
kosmo integrations:schema healthchecks-io.healthchecks_io_list_channels --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
healthchecks-io.healthchecks_io_list_badges 0 parameters
kosmo integrations:schema healthchecks-io.healthchecks_io_list_badges --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
healthchecks-io.healthchecks_io_get_status 0 parameters
kosmo integrations:schema healthchecks-io.healthchecks_io_get_status --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
healthchecks-io.healthchecks_io_ping_success_uuid 4 parameters
kosmo integrations:schema healthchecks-io.healthchecks_io_ping_success_uuid --json | Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | yes | uuid path parameter |
rid | string | no | rid query parameter |
http_method | string | no | Ping request method: HEAD, GET, or POST. Defaults to POST. |
body_text | string | no | Optional diagnostic text body for POST ping requests. |
healthchecks-io.healthchecks_io_ping_start_uuid 4 parameters
kosmo integrations:schema healthchecks-io.healthchecks_io_ping_start_uuid --json | Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | yes | uuid path parameter |
rid | string | no | rid query parameter |
http_method | string | no | Ping request method: HEAD, GET, or POST. Defaults to POST. |
body_text | string | no | Optional diagnostic text body for POST ping requests. |
healthchecks-io.healthchecks_io_ping_fail_uuid 4 parameters
kosmo integrations:schema healthchecks-io.healthchecks_io_ping_fail_uuid --json | Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | yes | uuid path parameter |
rid | string | no | rid query parameter |
http_method | string | no | Ping request method: HEAD, GET, or POST. Defaults to POST. |
body_text | string | no | Optional diagnostic text body for POST ping requests. |
healthchecks-io.healthchecks_io_ping_log_uuid 4 parameters
kosmo integrations:schema healthchecks-io.healthchecks_io_ping_log_uuid --json | Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | yes | uuid path parameter |
rid | string | no | rid query parameter |
http_method | string | no | Ping request method: HEAD, GET, or POST. Defaults to POST. |
body_text | string | no | Optional diagnostic text body for POST ping requests. |
healthchecks-io.healthchecks_io_ping_exit_status_uuid 5 parameters
kosmo integrations:schema healthchecks-io.healthchecks_io_ping_exit_status_uuid --json | Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | yes | uuid path parameter |
exit_status | number | yes | exit status path parameter |
rid | string | no | rid query parameter |
http_method | string | no | Ping request method: HEAD, GET, or POST. Defaults to POST. |
body_text | string | no | Optional diagnostic text body for POST ping requests. |
healthchecks-io.healthchecks_io_ping_success_slug 6 parameters
kosmo integrations:schema healthchecks-io.healthchecks_io_ping_success_slug --json | Parameter | Type | Required | Description |
|---|---|---|---|
ping_key | string | yes | ping key path parameter |
slug | string | yes | slug path parameter |
rid | string | no | rid query parameter |
create | string | no | create query parameter |
http_method | string | no | Ping request method: HEAD, GET, or POST. Defaults to POST. |
body_text | string | no | Optional diagnostic text body for POST ping requests. |
healthchecks-io.healthchecks_io_ping_start_slug 6 parameters
kosmo integrations:schema healthchecks-io.healthchecks_io_ping_start_slug --json | Parameter | Type | Required | Description |
|---|---|---|---|
ping_key | string | yes | ping key path parameter |
slug | string | yes | slug path parameter |
rid | string | no | rid query parameter |
create | string | no | create query parameter |
http_method | string | no | Ping request method: HEAD, GET, or POST. Defaults to POST. |
body_text | string | no | Optional diagnostic text body for POST ping requests. |
healthchecks-io.healthchecks_io_ping_fail_slug 6 parameters
kosmo integrations:schema healthchecks-io.healthchecks_io_ping_fail_slug --json | Parameter | Type | Required | Description |
|---|---|---|---|
ping_key | string | yes | ping key path parameter |
slug | string | yes | slug path parameter |
rid | string | no | rid query parameter |
create | string | no | create query parameter |
http_method | string | no | Ping request method: HEAD, GET, or POST. Defaults to POST. |
body_text | string | no | Optional diagnostic text body for POST ping requests. |
healthchecks-io.healthchecks_io_ping_log_slug 6 parameters
kosmo integrations:schema healthchecks-io.healthchecks_io_ping_log_slug --json | Parameter | Type | Required | Description |
|---|---|---|---|
ping_key | string | yes | ping key path parameter |
slug | string | yes | slug path parameter |
rid | string | no | rid query parameter |
create | string | no | create query parameter |
http_method | string | no | Ping request method: HEAD, GET, or POST. Defaults to POST. |
body_text | string | no | Optional diagnostic text body for POST ping requests. |
healthchecks-io.healthchecks_io_ping_exit_status_slug 7 parameters
kosmo integrations:schema healthchecks-io.healthchecks_io_ping_exit_status_slug --json | Parameter | Type | Required | Description |
|---|---|---|---|
ping_key | string | yes | ping key path parameter |
slug | string | yes | slug path parameter |
exit_status | number | yes | exit status path parameter |
rid | string | no | rid query parameter |
create | string | no | create query parameter |
http_method | string | no | Ping request method: HEAD, GET, or POST. Defaults to POST. |
body_text | string | no | Optional diagnostic text body for POST ping requests. |
Permissions
Headless calls still follow the integration read/write permission policy. Configure read/write defaults with
integrations:configure. Add --force only for trusted automation that should bypass that policy.