Skip to main content

Agent

Manage the agents in the fleet: discovery, drain and PKI enrollment. osapi controller endpoint get --name agent shows the same.

Endpoint group​

Nameagent
DescriptionManage the agents in the fleet: discovery, drain and PKI enrollment

Methods (5)​

NAMEVERBPATHPERMISSIONOPERATION ID
statusGET/api/agent/statushealth:readGetAgentStatus
listGET/api/agentagent:readGetAgents
getGET/api/agent/{hostname}agent:readGetAgentDetails
drainPOST/api/agent/{hostname}/drainagent:writeDrainAgent
undrainPOST/api/agent/{hostname}/undrainagent:writeUndrainAgent

Types (5)​

NAMEINPUTOUTPUT
statusStatusInputComponentList { total_items, items }
listListInputListAgentsResponse { items, total_items }
getGetInput { hostname* }AgentInfo { hostname, machine_id, state, conditions, labels, started_at, load_average, os_info, version, fingerprint, registered_at, uptime, memory, architecture, kernel_version, cpu_count, fqdn, service_mgr, package_mgr, primary_interface, interfaces, routes, facts, timeline, key_stored, verified }
drainDrainInput { hostname* }
undrainUndrainInput { hostname* }