Bulk upgrade agents Beta

POST /api/fleet/agents/bulk_upgrade

Headers

  • elastic-api-version string

    The version of the API to use

    Value is 2023-10-31. Default value is 2023-10-31.

  • kbn-xsrf string Required

    A required header to protect against CSRF attacks

application/json; Elastic-Api-Version=2023-10-31

Body

Responses

  • 200 application/json; Elastic-Api-Version=2023-10-31
    Hide response attribute Show response attribute object
  • 400 application/json; Elastic-Api-Version=2023-10-31
    Hide response attributes Show response attributes object
POST /api/fleet/agents/bulk_upgrade 
curl \
 -X POST https://localhost:5601/api/fleet/agents/bulk_upgrade \
 -H "Content-Type: application/json; Elastic-Api-Version=2023-10-31" \
 -H "elastic-api-version: 2023-10-31" \
 -H "kbn-xsrf: true"
Request examples 
# Headers
elastic-api-version: 2023-10-31
kbn-xsrf: true

# Payload
{
  "agents": [
    "string"
  ],
  "batchSize": 42.0,
  "force": true,
  "includeInactive": false,
  "rollout_duration_seconds": 42.0,
  "skipRateLimitCheck": true,
  "source_uri": "string",
  "start_time": "string",
  "version": "string"
}
Response examples (200) 
{
  "actionId": "string"
}
Response examples (400) 
{
  "error": "string",
  "message": "string",
  "statusCode": 42.0
}