Agent Health

List active Agent Health issues

Returns the active Agent Health issues for a node Agent or Cluster Agent resource.

get/api/v2/agenthealth/hosts/{resource_id}/issues

Request

Path parameters

resource_idstring required

Resource identifier whose active Agent Health issues should be returned: a DaemonSet UID for a node Agent or a cluster UUID for a Cluster Agent.

Query parameters

agent_type'node' | 'cluster'

Agent type associated with the resource.

Example:node

Agent type associated with the resource. Defaults to node when omitted.

Response

OK

Example response

{
  "data": {
    "attributes": {
      "issues": [
        {
          "category": "configuration",
          "issue_id": "invalid-config:4828e7d6c704c4a3",
          "issue_name": "Invalid Config",
          "issue_type": "invalid_config"
        }
      ]
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "agent_health_issues"
  }
}

Changes

Changes to this operation have not been checked yet.