List agents

Base URL
https://{kibana_url}
  • GET /api/fleet/agents
  • GET /s/{space_id}/api/fleet/agents
Auth

Path parameters

space_id string optional

An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Query parameters

perPage integer · default: 20

The number of items to return

page integer · default: 1
kuery string
showInactive boolean
showUpgradeable boolean
sortField string
sortOrder enum
Values: asc desc
withMetrics boolean

Return agent metrics, false by default

getStatusSummary boolean

Responses

OK

application/json
items object[] required
access_api_key string
access_api_key_id string
active boolean required
components object[]
id string
message string
status enum
Values: starting configuring healthy degraded failed stopping stopped
type string
units object[]
id string
message string
payload object
status enum
Values: starting configuring healthy degraded failed stopping stopped
type enum
Values: input output
default_api_key string
default_api_key_id string
enrolled_at string required
id string required
last_checkin string
local_metadata object
metrics object
cpu_avg number

Average agent CPU usage during the last 5 minutes, number between 0-1

memory_size_byte_avg number

Average agent memory consumption during the last 5 minutes

policy_id string
policy_revision number
status enum required
Values: offline error online inactive warning
type enum required
Values: PERMANENT EPHEMERAL TEMPORARY
unenrolled_at string
unenrollment_started_at string
user_provided_metadata object
list object[] deprecated
Same fields as items
page number required
perPage number required
statusSummary object
degraded' number
enrolling number
error number
inactive number
offline number
online number
unenrolled number
unenrolling number
updating number
total number required

Generic Error

application/json
error string
message string
statusCode number
Base URL
https://{kibana_url}