Upgrade an agent

Base URL: https://{kibana_url}

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

Auth

Upgrade a specific agent to a newer version.

Required privileges

Privileges fleet-agents-all

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: The agent ID

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

force boolean
skipRateLimitCheck boolean
source_uri string
version string required

Responses

Successful response

application/json

Response Type: object

Bad Request

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Upgrade an agent to a specific version

Console Kibana Dev Tools

POST kbn:/api/fleet/agents/AGENT_ID/upgrade
{
  "version": "8.17.0"
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/agents/${AGENT_ID}/upgrade" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "version": "8.17.0"
  }'

Generated from the API spec

Response

Agent upgrade initiated

{}

{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}