Restart an agent

Base URL: https://{kibana_url}

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

Refer to Spaces for more information.

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

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Header parameters

Responses

OK: A successful request.

application/json

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/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"
}