List agents
Server:
https://{kibana_url}
- GET /api/fleet/agents
- GET /s/{space_id}/api/fleet/agents
Refer to Spaces for more information.
Query Parameters
-
perPageinteger · default: 20 The number of items to return
-
pageinteger · default: 1 -
kuerystring -
showInactiveboolean -
showUpgradeableboolean -
sortFieldstring -
sortOrder -
Values:
ascdesc -
withMetricsboolean Return agent metrics, false by default
-
getStatusSummaryboolean
Responses
OK
-
itemsobjectrequired -
access_api_keystring -
access_api_key_idstring -
activebooleanrequired -
componentsobject -
default_api_keystring -
default_api_key_idstring -
enrolled_atstringrequired -
idstringrequired -
last_checkinstring -
local_metadataobject -
metricsobject -
cpu_avgnumber -
Average agent CPU usage during the last 5 minutes, number between 0-1
-
memory_size_byte_avgnumber -
Average agent memory consumption during the last 5 minutes
-
policy_idstring -
policy_revisionnumber -
statusrequired -
Values:
offlineerroronlineinactivewarning -
typerequired -
Values:
PERMANENTEPHEMERALTEMPORARY -
unenrolled_atstring -
unenrollment_started_atstring -
user_provided_metadataobject -
listobjectdeprecated -
pagenumberrequired -
perPagenumberrequired -
statusSummaryobject -
degraded'number -
enrollingnumber -
errornumber -
inactivenumber -
offlinenumber -
onlinenumber -
unenrollednumber -
unenrollingnumber -
updatingnumber -
totalnumberrequired
Generic Error
-
errorstring -
messagestring -
statusCodenumber