Unenroll an agent

Base URL: https://{kibana_url}

POST /api/fleet/agents/{agentId}/unenroll

Auth

Unenroll a specific agent, optionally revoking its enrollment API key.

Required privileges

Privileges fleet-agents-all

Path parameters

agentId string required: The agent ID

Header parameters

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

Request body

force boolean
revoke boolean

Responses

200

Successful response

application/json

400

Bad Request

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Unenroll an agent, optionally revoking the enrollment API key

Console Kibana Dev Tools

POST kbn:/api/fleet/agents/AGENT_ID/unenroll
{
  "revoke": false
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/agents/${AGENT_ID}/unenroll" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "revoke": false
  }'

Generated from the API spec

Response

Agent successfully unenrolled

{}

{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}