Restart an agent

Auth

Restart an Elastic Agent. The request fails when the agent is inactive, on a version earlier than 9.6.0, or enrolled in a hosted agent policy.

Required authorization

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.
agentId string · max length: 512 required: The agent ID to restart

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

OK: A successful request.

application/json

Any of:

A bad request.

application/json

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/fleet/agents/AGENT_ID/restart

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/agents/${AGENT_ID}/restart" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

{
  "actionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

{
  "message": "Bad Request"
}