Restart an agent

Base URL: https://{kibana_url}

POST /api/fleet/agents/{agentId}/restart
POST /s/{space_id}/api/fleet/agents/{agentId}/restart

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. It also fails with a 409 when the agent already has a pending restart action, unless force is set.

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

Header parameters

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

Request body

force boolean: Restart the agent even if it already has a pending restart action.

Responses

OK: A successful request.

application/json

Any of:

actionId string required

A bad request.

application/json

A conflict occurred: the agent already has a pending restart action.

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/fleet/agents/AGENT_ID/restart
{
  "force": true
}

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}" \
  -H "Content-Type: application/json" \
  -d '{
    "force": true
  }'

Generated from the API spec

Response

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

{
  "message": "Bad Request"
}

{
  "error": "Conflict",
  "message": "Agent agent-1 already has a pending restart action a1b2c3d4-e5f6-7890-abcd-ef1234567890. Use force to restart anyway.",
  "statusCode": 409
}

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}" \
  -H "Content-Type: application/json" \
  -d '{}'

Generated from the API spec

Response

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

{
  "message": "Bad Request"
}

{
  "error": "Conflict",
  "message": "Agent agent-1 already has a pending restart action a1b2c3d4-e5f6-7890-abcd-ef1234567890. Use force to restart anyway.",
  "statusCode": 409
}

Required privileges

Path parameters

Header parameters

Request body { }

Responses

Request body