v1
latestOpenAPI 3.0.02026-08-04891301.4 MBList health actions for an agent
Returns all health actions associated with a given agent. Health actions represent required or recommended steps — such as setting environment variables, completing OAuth installations, or running custom verifiers — that an agent needs to reach a healthy state.
Results are not paginated; the full list for the agent is returned. Use the source, status, and kind filters to narrow results to the subset your UI or workflow needs. Multiple values for the same filter are treated as OR (e.g. passing two statuses returns actions matching either). The caller must be authenticated and scoped to the app that owns the agent.
Path parameters
Agent ID (agt_...) or lookup key of the agent whose health actions you want to list.
Query parameters
Filter results to actions from one or more lifecycle stages. Accepted values: "setup" (actions created during agent installation) and "health" (ongoing health checks). Omit to return actions from all stages.
Filter results to actions in one or more statuses. Accepted values: "pending", "completed", "skipped", and "degraded". Omit to return actions in all statuses.
Filter results to actions of one or more kinds. Accepted values: "env_var" (a required secret or config value), "install" (an OAuth or integration install step), and "custom" (a platform-defined check). Omit to return all kinds.
Response
Successful response
Example response
{
"data": [
{
"agent": "agi_0aBcDeFgHiJkLmNoPqRsTu",
"app": "dap_0aBcDeFgHiJkLmNoPqRsTu",
"created_at": "2024-01-01T00:00:00Z",
"depends_on": [
"string"
],
"description": "An example description.",
"id": "aha_0aBcDeFgHiJkLmNoPqRsTu",
"kind": "env_var",
"last_verified_at": "2024-01-01T00:00:00Z",
"last_verifier_message": "string",
"org": "org_0aBcDeFgHiJkLmNoPqRsTu",
"params": {
"key": "value"
},
"required": true,
"sort_order": 1,
"source": "setup",
"status": "pending",
"title": "Example Title",
"updated_at": "2024-01-01T00:00:00Z",
"verify_config": {}
}
]
}