Bulk rollback agents

Base URL: https://{kibana_url}

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

Auth

Rollback multiple agents to the previous 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.

Header parameters

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

Request body

agents union string[] | string required
batchSize number
dryRun boolean
includeInactive boolean · default: false

Responses

OK: A successful request.

application/json

Any of:

actionIds string[] · max items: 10000 required

A bad request.

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/fleet/agents/bulk_rollback
{
  "agents": [
    "agent-1",
    "agent-2"
  ],
  "batchSize": 100,
  "includeInactive": false
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/agents/bulk_rollback" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "agents": [
      "agent-1",
      "agent-2"
    ],
    "batchSize": 100,
    "includeInactive": false
  }'

Generated from the API spec

Response

{
  "actionIds": [
    "actionId1",
    "actionId2"
  ]
}

{
  "message": "Bad Request"
}