Bulk restart agents

Base URL: https://{kibana_url}

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

Auth

Restart multiple Elastic Agents. Agents that are enrolled in a hosted policy, are on a version earlier than 9.6.0, or already have a pending restart action (unless force is set) are excluded from the action and receive individual error results.

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 · min: 1
force boolean: Restart agents even if they already have a pending restart action.
includeInactive boolean · default: false

Responses

OK: A successful request.

application/json

Any of:

actionId string required

A bad request.

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/fleet/agents/bulk_restart
{
  "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_restart" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "agents": [
      "agent-1",
      "agent-2"
    ],
    "batchSize": 100,
    "includeInactive": false
  }'