Upgrade an agent

Base URL: https://{kibana_url}

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

Upgrade a specific agent to a newer version.

Required authorization

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Header parameters

Request body

Responses

Successful response

application/json

Bad Request

application/json

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"
  }'