Update agent by ID

Base URL
https://{kibana_url}
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.

agentId string required

Header parameters

kbn-xsrf string required

Kibana's anti Cross-Site Request Forgery token. Can be any string value.

Request body

tags string[]
user_provided_metadata object

Responses

OK

application/json
item 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

Generic Error

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