List agent policies
https://{kibana_url}
- GET /api/fleet/agent_policies
- GET /s/{space_id}/api/fleet/agent_policies
Refer to Spaces for more information.
Query Parameters
-
perPageinteger · default: 20 The number of items to return
-
pageinteger · default: 1 -
kuerystring -
fullboolean When set to true, retrieve the related package policies for each agent policy.
-
noAgentCountboolean When set to true, do not count how many agents are in the agent policy, this can improve performance if you are searching over a large number of agent policies. The "agents" property will always be 0 if set to true.
Responses
OK
-
itemsobjectrequired -
advanced_settingsobjectnullable -
Advanced settings stored in the agent policy, e.g. agent_limits_go_max_procs
-
agent_featuresobject -
agentsnumber -
data_output_idstringnullable -
descriptionstring -
download_source_idstringnullable -
fleet_server_host_idstringnullable -
idstringrequired -
inactivity_timeoutinteger -
is_protectedboolean -
Indicates whether the agent policy has tamper protection enabled. Default false.
-
keep_monitoring_alivebooleannullable -
When set to true, monitoring will be enabled but logs/metrics collection will be disabled
-
monitoring_diagnosticsobject -
monitoring_enabled -
Values:
metricslogs -
monitoring_httpobject -
monitoring_output_idstringnullable -
monitoring_pprof_enabledboolean -
namestringrequired -
namespacestringrequired -
overridesobjectnullable -
Override settings that are defined in the agent policy. Input settings cannot be overridden. The override option should be used only in unusual circumstances and not as a routine procedure.
-
package_policiesobject -
This field is present only when retrieving a single agent policy, or when retrieving a list of agent policies with the ?full=true parameter
-
idstringrequired -
inputsoneOfrequired -
revisionnumberrequired -
descriptionstring -
enabledboolean -
namestringrequired -
namespacestring -
output_idstring -
overridesobject -
packageobject -
namestringrequired -
requires_rootboolean -
titlestring -
versionstringrequired -
policy_idstringnullable deprecated -
policy_idsstring -
revisionnumber -
supports_agentlessboolean -
Indicates whether the agent policy supports agentless integrations. Only allowed in a serverless environment.
-
unenroll_timeoutinteger -
unprivileged_agentsnumber -
updated_bystring -
updated_onstring -
pagenumberrequired -
perPagenumberrequired -
totalnumberrequired
Generic Error
-
errorstring -
messagestring -
statusCodenumber