Upgrade agent

POST /api/fleet/agents/{agentId}/upgrade

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

force boolean

Force upgrade, skipping validation (should be used with caution)
skipRateLimitCheck boolean

Skip rate limit check for upgrade
source_uri string
version string Required

Responses

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

OK
Hide response attributes Show response attributes object
- force boolean
  
  Force upgrade, skipping validation (should be used with caution)
- skipRateLimitCheck boolean
  
  Skip rate limit check for upgrade
- source_uri string
- version string Required
400 application/json; Elastic-Api-Version=2023-10-31

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

POST /api/fleet/agents/{agentId}/upgrade

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

Request examples

# Headers
kbn-xsrf: string

# Payload
{
  "force": true,
  "skipRateLimitCheck": true,
  "source_uri": "string",
  "version": "string"
}

Response examples (200)

{
  "force": true,
  "skipRateLimitCheck": true,
  "source_uri": "string",
  "version": "string"
}

Response examples (400)

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