Upgrade agent

Base URL: https://{kibana_url}

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

Auth

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

Header parameters

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

Request body

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

OK

application/json

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

Generic Error

application/json

error string
message string
statusCode number

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

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

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

Generated from the API spec

Response

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

Generated from the API spec

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

Generated from the API spec