POST /api/fleet/agents/{agentId}/upgrade
Api key auth

Spaces method and path for this operation:

post /s/{space_id}/api/fleet/agents/{agentId}/upgrade

Refer to Spaces for more information.

Upgrade a specific agent to a newer version.

[Required authorization] Route required privileges: fleet-agents-all.

Headers

  • kbn-xsrf string Required

    A required header to protect against CSRF attacks

Path parameters

  • agentId string Required
application/json

Body

  • force boolean
  • skipRateLimitCheck boolean
  • source_uri string
  • version string Required

Responses

  • 200 application/json

    Successful response

    Additional properties are NOT allowed.
  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • attributes Required
    • error string
    • errorType string
    • message string Required
    • statusCode number
POST /api/fleet/agents/{agentId}/upgrade 
curl \
 --request POST 'https://<KIBANA_URL>/api/fleet/agents/{agentId}/upgrade' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "kbn-xsrf: true" \
 --data '{"version":"8.17.0"}'
Request example
Upgrade an agent to a specific version 
{
  "version": "8.17.0"
}
Response examples (200)
Agent upgrade initiated 
{
  "description": "Agent upgrade initiated",
  "value": {}
}
Response examples (400)
Example of a generic error response 
{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}