Check definitions reference – Configly Help Centre

Overview

Retrieve the full list of health checks that the engine can run against a connection's configuration. This is useful for understanding what each check does before running a health check, or for mapping finding IDs back to their definitions.

Request

curl https://api.configly.app/v1/connections/{connectionId}/health-check/checks \
  -H "Authorization: Bearer cly_your_key"

This endpoint requires a READ_ONLY key at minimum.

Response

{
  "data": [
    {
      "id": "inactive-triggers",
      "name": "Inactive triggers",
      "description": "Detects triggers that are disabled and have not fired in over 90 days.",
      "category": "hygiene",
      "severity": "warning"
    },
    {
      "id": "missing-sla-targets",
      "name": "Missing SLA targets",
      "description": "Identifies SLA policies with no target metrics defined.",
      "category": "compliance",
      "severity": "critical"
    },
    {
      "id": "duplicate-macros",
      "name": "Duplicate macros",
      "description": "Finds macros with identical action sets that could be consolidated.",
      "category": "hygiene",
      "severity": "info"
    }
  ],
  "meta": {
    "total": 3
  }
}

Field	Type	Description
`id`	string	Unique identifier for the check
`name`	string	Human-readable check name
`description`	string	Explanation of what the check detects
`category`	string	Grouping category (e.g. `hygiene`, `compliance`)
`severity`	string	Default severity: `critical`, `warning`, or `info`

Checks vs. findings

This endpoint returns every check the engine knows about. The findings that appear in a specific health check report depend on your subscription tier; lower tiers may see a subset of the available findings.

To run a check, see Running health checks.

Related to