Type to search.

Bulk restart agents

Base URL
https://{kibana_url}
  • POST /api/fleet/agents/bulk_restart
  • POST /s/{space_id}/api/fleet/agents/bulk_restart
Auth The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Planned We plan to add this functionality in a future Elastic Stack update. Subject to changes. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

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