Update agent by ID

PUT /api/fleet/agents/{agentId}

Headers

kbn-xsrf string Required

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

Path parameters

agentId string Required

application/json; Elastic-Api-Version=2023-10-31

Body Required

tags array[string]
user_provided_metadata object

Additional properties are allowed.

Responses

200 application/json; Elastic-Api-Version=2023-10-31

OK
Hide response attribute Show response attribute object
- item object Required
  
  Additional properties are allowed.
  
  Hide item attributes Show item attributes object
  
  access_api_key string
  
  access_api_key_id string
  
  active boolean Required
  
  components array[object]
  
  Hide components attributes Show components attributes object
  
  id string
  
  message string
  
  status string
  
  Values are starting, configuring, healthy, degraded, failed, stopping, or stopped.
  
  type string
  
  units array[object]
  
  Hide units attributes Show units attributes object
  
  id string
  
  message string
  
  payload object
  
  Additional properties are allowed.
  
  status string
  
  Values are starting, configuring, healthy, degraded, failed, stopping, or stopped.
  
  type string
  
  Values are input or output.
  
  default_api_key string
  
  default_api_key_id string
  
  enrolled_at string Required
  
  id string Required
  
  last_checkin string
  
  local_metadata object
  
  Additional properties are allowed.
  
  metrics object
  
  Additional properties are allowed.
  
  Hide metrics attributes Show metrics attributes 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 string Required
  
  Values are offline, error, online, inactive, or warning.
  
  type string Required
  
  Values are PERMANENT, EPHEMERAL, or TEMPORARY.
  
  unenrolled_at string
  
  unenrollment_started_at string
  
  user_provided_metadata object
  
  Additional properties are allowed.
400 application/json; Elastic-Api-Version=2023-10-31

Generic Error
Hide response attributes Show response attributes object
- error string
- message string
- statusCode number

PUT /api/fleet/agents/{agentId}

curl \
 -X PUT https://localhost:5601/api/fleet/agents/{agentId} \
 -H "Content-Type: application/json; Elastic-Api-Version=2023-10-31" \
 -H "kbn-xsrf: string"

Request examples

# Headers
kbn-xsrf: string

# Payload
{
  "tags": [
    "string"
  ],
  "user_provided_metadata": {}
}

Response examples (200)

{
  "item": {
    "access_api_key": "string",
    "access_api_key_id": "string",
    "active": true,
    "components": [
      {
        "id": "string",
        "message": "string",
        "status": "starting",
        "type": "string",
        "units": [
          {
            "id": "string",
            "message": "string",
            "payload": {},
            "status": "starting",
            "type": "input"
          }
        ]
      }
    ],
    "default_api_key": "string",
    "default_api_key_id": "string",
    "enrolled_at": "string",
    "id": "string",
    "last_checkin": "string",
    "local_metadata": {},
    "metrics": {
      "cpu_avg": 42.0,
      "memory_size_byte_avg": 42.0
    },
    "policy_id": "string",
    "policy_revision": 42.0,
    "status": "offline",
    "type": "PERMANENT",
    "unenrolled_at": "string",
    "unenrollment_started_at": "string",
    "user_provided_metadata": {}
  }
}

Response examples (400)

{
  "error": "string",
  "message": "string",
  "statusCode": 42.0
}