Bulk upgrade agents

Server: https://{kibana_url}

POST /api/fleet/agents/bulk_upgrade
POST /s/{space_id}/api/fleet/agents/bulk_upgrade

Refer to Spaces for more information.

Upgrade multiple agents to a newer version, with optional rollout controls.

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

Request

Responses

Successful response

application/json

Bad Request

application/json

Examples

Upgrade multiple agents to a specific version

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST /api/fleet/agents/bulk_upgrade
{
  "agents": [
    "agent-id-1",
    "agent-id-2"
  ],
  "rollout_duration_seconds": 3600,
  "version": "8.17.0"
}

curl Shell

curl -X POST "https://{kibana_url}/api/fleet/agents/bulk_upgrade" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
  "agents": [
    "agent-id-1",
    "agent-id-2"
  ],
  "rollout_duration_seconds": 3600,
  "version": "8.17.0"
}'

Response

{
  "actionId": "action-id-1"
}

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

Request { agents , batchSize , dryRun , force , includeInactive , rollout_duration_seconds , skipRateLimitCheck , source_uri , start_time , version , }

Responses

Request