Get API key info
get_api_key_infoReveals the active Healthchecks instance, API key status, and permission level: read-only or read-write. These permissions determine which endpoints are accessible and whether checks are identified by UUID or unique key.
Instructions
Reports which instance is configured, whether the API key works, and whether it is a read-only or a read-write key — which decides whether list_pings, get_ping_body and list_integrations can be used at all, and whether checks are identified by uuid or by unique_key.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | ||
| note | No | ||
| error | No | ||
| api_key | No | Only when none is configured. | |
| accepted | No | ||
| instance | Yes | ||
| reachable | No | ||
| prefixed_hcr | No | ||
| key_length_ok | No | ||
| unavailable_tools | No | ||
| checks_identified_by | No |